| |
| |
| <!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>Compute Functions — 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/compute';</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/compute.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="Streaming Execution (Acero)" href="acero.html" /> |
| <link rel="prev" title="C Interfaces" href="c_abi.html" /> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <meta name="docsearch:language" content="en"/> |
| |
| <!-- Matomo --> |
| <script> |
| var _paq = window._paq = window._paq || []; |
| /* tracker methods like "setCustomDimension" should be called before "trackPageView" */ |
| /* We explicitly disable cookie tracking to avoid privacy issues */ |
| _paq.push(['disableCookies']); |
| _paq.push(['trackPageView']); |
| _paq.push(['enableLinkTracking']); |
| (function() { |
| var u="https://analytics.apache.org/"; |
| _paq.push(['setTrackerUrl', u+'matomo.php']); |
| _paq.push(['setSiteId', '20']); |
| var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; |
| g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s); |
| })(); |
| </script> |
| <!-- End Matomo Code --> |
| |
| </head> |
| |
| |
| <body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode=""> |
| |
| |
| |
| <a id="pst-skip-link" class="skip-link" href="#main-content">Skip to main content</a> |
| |
| <div id="pst-scroll-pixel-helper"></div> |
| |
| <button type="button" class="btn rounded-pill" id="pst-back-to-top"> |
| <i class="fa-solid fa-arrow-up"></i> |
| Back to top |
| </button> |
| |
| |
| <input type="checkbox" |
| class="sidebar-toggle" |
| name="__primary" |
| id="__primary"/> |
| <label class="overlay overlay-primary" for="__primary"></label> |
| |
| <input type="checkbox" |
| class="sidebar-toggle" |
| name="__secondary" |
| id="__secondary"/> |
| <label class="overlay overlay-secondary" for="__secondary"></label> |
| |
| <div class="search-button__wrapper"> |
| <div class="search-button__overlay"></div> |
| <div class="search-button__search-container"> |
| <form class="bd-search d-flex align-items-center" |
| action="../../search.html" |
| method="get"> |
| <i class="fa-solid fa-magnifying-glass"></i> |
| <input type="search" |
| class="form-control" |
| name="q" |
| id="search-input" |
| placeholder="Search the docs ..." |
| aria-label="Search the docs ..." |
| autocomplete="off" |
| autocorrect="off" |
| autocapitalize="off" |
| spellcheck="false"/> |
| <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span> |
| </form></div> |
| </div> |
| |
| <header class="bd-header navbar navbar-expand-lg bd-navbar"> |
| <div class="bd-header__inner bd-page-width"> |
| <label class="sidebar-toggle primary-toggle" for="__primary"> |
| <span class="fa-solid fa-bars"></span> |
| </label> |
| |
| |
| <div class="col-lg-3 navbar-header-items__start"> |
| |
| <div class="navbar-item"> |
| |
| |
| |
| <a class="navbar-brand logo" href="../../index.html"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <img src="../../_static/arrow.png" class="logo__image only-light" alt="Apache Arrow v17.0.0.dev52 - Home"/> |
| <script>document.write(`<img src="../../_static/arrow-dark.png" class="logo__image only-dark" alt="Apache Arrow v17.0.0.dev52 - Home"/>`);</script> |
| |
| |
| </a></div> |
| |
| </div> |
| |
| <div class="col-lg-9 navbar-header-items"> |
| |
| <div class="me-auto navbar-header-items__center"> |
| |
| <div class="navbar-item"> |
| <nav class="navbar-nav"> |
| <ul class="bd-navbar-elements navbar-nav"> |
| |
| <li class="nav-item"> |
| <a class="nav-link nav-internal" href="../../format/index.html"> |
| Specifications |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link nav-internal" href="../../developers/index.html"> |
| Development |
| </a> |
| </li> |
| |
| <li class="nav-item dropdown"> |
| <button class="btn dropdown-toggle nav-item" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-controls="pst-nav-more-links"> |
| Implementations |
| </button> |
| <ul id="pst-nav-more-links" class="dropdown-menu"> |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../c_glib/index.html"> |
| C/GLib |
| </a> |
| </li> |
| |
| |
| <li class="nav-item current active"> |
| <a class="nav-link dropdown-item nav-internal" href="../index.html"> |
| C++ |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/csharp/README.md"> |
| C# |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://pkg.go.dev/github.com/apache/arrow/go/v17"> |
| Go |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../java/index.html"> |
| Java |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../js/index.html"> |
| JavaScript |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/julia/"> |
| Julia |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/matlab/README.md"> |
| MATLAB |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/nanoarrow/"> |
| nanoarrow |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../python/index.html"> |
| Python |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../r/index.html"> |
| R |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/ruby/README.md"> |
| Ruby |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://docs.rs/crate/arrow/"> |
| Rust |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../status.html"> |
| Implementation Status |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/cpp/"> |
| C++ cookbook |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/java/"> |
| Java cookbook |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/py/"> |
| Python cookbook |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/r/"> |
| R cookbook |
| </a> |
| </li> |
| |
| </ul> |
| </li> |
| |
| </ul> |
| </nav></div> |
| |
| </div> |
| |
| |
| <div class="navbar-header-items__end"> |
| |
| <div class="navbar-item navbar-persistent--container"> |
| |
| |
| <script> |
| document.write(` |
| <button class="btn navbar-btn search-button-field search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip"> |
| <i class="fa-solid fa-magnifying-glass"></i> |
| <span class="search-button__default-text">Search</span> |
| <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span> |
| </button> |
| `); |
| </script> |
| </div> |
| |
| |
| <div class="navbar-item"> |
| <script> |
| document.write(` |
| <div class="version-switcher__container dropdown"> |
| <button id="pst-version-switcher-button-2" |
| type="button" |
| class="version-switcher__button btn btn-sm navbar-btn dropdown-toggle" |
| data-bs-toggle="dropdown" |
| aria-haspopup="listbox" |
| aria-controls="pst-version-switcher-list-2" |
| aria-label="Version switcher list" |
| > |
| Choose version <!-- this text may get changed later by javascript --> |
| <span class="caret"></span> |
| </button> |
| <div id="pst-version-switcher-list-2" |
| class="version-switcher__menu dropdown-menu list-group-flush py-0" |
| role="listbox" aria-labelledby="pst-version-switcher-button-2"> |
| <!-- dropdown will be populated by javascript on page load --> |
| </div> |
| </div> |
| `); |
| </script></div> |
| |
| <div class="navbar-item"> |
| |
| <script> |
| document.write(` |
| <button class="btn btn-sm navbar-btn theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip"> |
| <span class="theme-switch nav-link" data-mode="light"><i class="fa-solid fa-sun fa-lg"></i></span> |
| <span class="theme-switch nav-link" data-mode="dark"><i class="fa-solid fa-moon fa-lg"></i></span> |
| <span class="theme-switch nav-link" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg"></i></span> |
| </button> |
| `); |
| </script></div> |
| |
| <div class="navbar-item"><ul class="navbar-icon-links navbar-nav" |
| aria-label="Icon Links"> |
| <li class="nav-item"> |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href="https://github.com/apache/arrow" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i></span> |
| <span class="sr-only">GitHub</span></a> |
| </li> |
| <li class="nav-item"> |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href="https://twitter.com/ApacheArrow" title="X" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-x-twitter fa-lg" aria-hidden="true"></i></span> |
| <span class="sr-only">X</span></a> |
| </li> |
| </ul></div> |
| |
| </div> |
| |
| </div> |
| |
| |
| <div class="navbar-persistent--mobile"> |
| |
| <script> |
| document.write(` |
| <button class="btn navbar-btn search-button-field search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip"> |
| <i class="fa-solid fa-magnifying-glass"></i> |
| <span class="search-button__default-text">Search</span> |
| <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span> |
| </button> |
| `); |
| </script> |
| </div> |
| |
| |
| |
| <label class="sidebar-toggle secondary-toggle" for="__secondary" tabindex="0"> |
| <span class="fa-solid fa-outdent"></span> |
| </label> |
| |
| </div> |
| |
| </header> |
| |
| |
| <div class="bd-container"> |
| <div class="bd-container__inner bd-page-width"> |
| |
| |
| |
| <div class="bd-sidebar-primary bd-sidebar"> |
| |
| |
| |
| <div class="sidebar-header-items sidebar-primary__section"> |
| |
| |
| <div class="sidebar-header-items__center"> |
| |
| <div class="navbar-item"> |
| <nav class="navbar-nav"> |
| <ul class="bd-navbar-elements navbar-nav"> |
| |
| <li class="nav-item"> |
| <a class="nav-link nav-internal" href="../../format/index.html"> |
| Specifications |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link nav-internal" href="../../developers/index.html"> |
| Development |
| </a> |
| </li> |
| |
| <li class="nav-item dropdown"> |
| <button class="btn dropdown-toggle nav-item" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-controls="pst-nav-more-links-2"> |
| Implementations |
| </button> |
| <ul id="pst-nav-more-links-2" class="dropdown-menu"> |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../c_glib/index.html"> |
| C/GLib |
| </a> |
| </li> |
| |
| |
| <li class="nav-item current active"> |
| <a class="nav-link dropdown-item nav-internal" href="../index.html"> |
| C++ |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/csharp/README.md"> |
| C# |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://pkg.go.dev/github.com/apache/arrow/go/v17"> |
| Go |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../java/index.html"> |
| Java |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../js/index.html"> |
| JavaScript |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/julia/"> |
| Julia |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/matlab/README.md"> |
| MATLAB |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/nanoarrow/"> |
| nanoarrow |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../python/index.html"> |
| Python |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../r/index.html"> |
| R |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/ruby/README.md"> |
| Ruby |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://docs.rs/crate/arrow/"> |
| Rust |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../status.html"> |
| Implementation Status |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/cpp/"> |
| C++ cookbook |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/java/"> |
| Java cookbook |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/py/"> |
| Python cookbook |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/r/"> |
| R cookbook |
| </a> |
| </li> |
| |
| </ul> |
| </li> |
| |
| </ul> |
| </nav></div> |
| |
| </div> |
| |
| |
| |
| <div class="sidebar-header-items__end"> |
| |
| <div class="navbar-item"> |
| <script> |
| document.write(` |
| <div class="version-switcher__container dropdown"> |
| <button id="pst-version-switcher-button-3" |
| type="button" |
| class="version-switcher__button btn btn-sm navbar-btn dropdown-toggle" |
| data-bs-toggle="dropdown" |
| aria-haspopup="listbox" |
| aria-controls="pst-version-switcher-list-3" |
| aria-label="Version switcher list" |
| > |
| Choose version <!-- this text may get changed later by javascript --> |
| <span class="caret"></span> |
| </button> |
| <div id="pst-version-switcher-list-3" |
| class="version-switcher__menu dropdown-menu list-group-flush py-0" |
| role="listbox" aria-labelledby="pst-version-switcher-button-3"> |
| <!-- dropdown will be populated by javascript on page load --> |
| </div> |
| </div> |
| `); |
| </script></div> |
| |
| <div class="navbar-item"> |
| |
| <script> |
| document.write(` |
| <button class="btn btn-sm navbar-btn theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip"> |
| <span class="theme-switch nav-link" data-mode="light"><i class="fa-solid fa-sun fa-lg"></i></span> |
| <span class="theme-switch nav-link" data-mode="dark"><i class="fa-solid fa-moon fa-lg"></i></span> |
| <span class="theme-switch nav-link" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg"></i></span> |
| </button> |
| `); |
| </script></div> |
| |
| <div class="navbar-item"><ul class="navbar-icon-links navbar-nav" |
| aria-label="Icon Links"> |
| <li class="nav-item"> |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href="https://github.com/apache/arrow" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i></span> |
| <span class="sr-only">GitHub</span></a> |
| </li> |
| <li class="nav-item"> |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href="https://twitter.com/ApacheArrow" title="X" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-x-twitter fa-lg" aria-hidden="true"></i></span> |
| <span class="sr-only">X</span></a> |
| </li> |
| </ul></div> |
| |
| </div> |
| |
| </div> |
| |
| <div class="sidebar-primary-items__start sidebar-primary__section"> |
| <div class="sidebar-primary-item"> |
| <nav class="bd-docs-nav bd-links" |
| aria-label="Section Navigation"> |
| <p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p> |
| <div class="bd-toc-item navbar-nav"><ul class="current nav bd-sidenav"> |
| <li class="toctree-l1 has-children"><a class="reference internal" href="../getting_started.html">Getting Started</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul> |
| <li class="toctree-l2"><a class="reference internal" href="../build_system.html">Using Arrow C++ in your own project</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../conventions.html">Conventions</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../tutorials/basic_arrow.html">Basic Arrow Data Structures</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../tutorials/io_tutorial.html">Arrow File I/O</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../tutorials/compute_tutorial.html">Arrow Compute</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../tutorials/datasets_tutorial.html">Arrow Datasets</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1 has-children"><a class="reference internal" href="../user_guide.html">User Guide</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-2"><i class="fa-solid fa-chevron-down"></i></label><ul> |
| <li class="toctree-l2"><a class="reference internal" href="../overview.html">High-Level Overview</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../memory.html">Memory Management</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../arrays.html">Arrays</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../datatypes.html">Data Types</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../tables.html">Tabular Data</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../compute.html">Compute Functions</a></li> |
| <li class="toctree-l2 has-children"><a class="reference internal" href="../gandiva.html">The Gandiva Expression Compiler</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul> |
| <li class="toctree-l3"><a class="reference internal" href="../gandiva/expr_projector_filter.html">Gandiva Expression, Projector, and Filter</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../gandiva/external_func.html">Gandiva External Functions Development Guide</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2 has-children"><a class="reference internal" href="../streaming_execution.html">Acero: A C++ streaming execution engine</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-4"><i class="fa-solid fa-chevron-down"></i></label><ul> |
| <li class="toctree-l3"><a class="reference internal" href="../acero/overview.html">Acero Overview</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../acero/user_guide.html">Acero User’s Guide</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../acero/substrait.html">Using Acero with Substrait</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../acero/developer_guide.html">Developer’s Guide</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../io.html">Input / output and filesystems</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../ipc.html">Reading and writing the Arrow IPC format</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../orc.html">Reading and Writing ORC files</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../parquet.html">Reading and writing Parquet files</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../csv.html">Reading and Writing CSV files</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../json.html">Reading JSON files</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../dataset.html">Tabular Datasets</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../flight.html">Arrow Flight RPC</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../gdb.html">Debugging code using Arrow</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../threading.html">Thread Management</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../opentelemetry.html">OpenTelemetry</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../env_vars.html">Environment Variables</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1 has-children"><a class="reference internal" href="../examples/index.html">Examples</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-5"><i class="fa-solid fa-chevron-down"></i></label><ul> |
| <li class="toctree-l2"><a class="reference internal" href="../examples/cmake_minimal_build.html">Minimal build using CMake</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../examples/compute_and_write_example.html">Compute and Write CSV Example</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../examples/dataset_documentation_example.html">Arrow Datasets example</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../examples/dataset_skyhook_scan_example.html">Arrow Skyhook example</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../examples/row_columnar_conversion.html">Row to columnar conversion</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../examples/tuple_range_conversion.html">std::tuple-like ranges to Arrow</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../examples/converting_recordbatch_to_tensor.html">Converting RecordBatch to Tensor</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1 current active has-children"><a class="reference internal" href="../api.html">API Reference</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-6"><i class="fa-solid fa-chevron-down"></i></label><ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="support.html">Programming Support</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="memory.html">Memory (management)</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="thread.html">Thread (management)</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="datatype.html">Data Types</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="array.html">Arrays</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="scalar.html">Scalars</a></li> |
| <li class="toctree-l2"><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 current active"><a class="current reference internal" href="#">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">Compute Functions</li> |
| </ul> |
| </nav> |
| </div> |
| |
| </div> |
| |
| |
| </div> |
| </div> |
| |
| |
| |
| |
| <div id="searchbox"></div> |
| <article class="bd-article"> |
| |
| <section id="compute-functions"> |
| <h1>Compute Functions<a class="headerlink" href="#compute-functions" title="Permalink to this heading">#</a></h1> |
| <section id="datum-class"> |
| <h2>Datum class<a class="headerlink" href="#datum-class" title="Permalink to this heading">#</a></h2> |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5DatumE"> |
| <span id="_CPPv3N5arrow5DatumE"></span><span id="_CPPv2N5arrow5DatumE"></span><span id="arrow::Datum"></span><span class="target" id="structarrow_1_1_datum"></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">Datum</span></span></span><a class="headerlink" href="#_CPPv4N5arrow5DatumE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Variant type for various Arrow C++ data structures. </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 enum"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Datum4KindE"> |
| <span id="_CPPv3N5arrow5Datum4KindE"></span><span id="_CPPv2N5arrow5Datum4KindE"></span><span class="target" id="structarrow_1_1_datum_1aef17d22c0c1f9ca9d4e32a4a914f4d60"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Kind</span></span></span><a class="headerlink" href="#_CPPv4N5arrow5Datum4KindE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The kind of datum stored. </p> |
| <p><em>Values:</em></p> |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Datum4Kind4NONEE"> |
| <span id="_CPPv3N5arrow5Datum4Kind4NONEE"></span><span id="_CPPv2N5arrow5Datum4Kind4NONEE"></span><span class="target" id="structarrow_1_1_datum_1aef17d22c0c1f9ca9d4e32a4a914f4d60ad3d00510a81481f708609c2aeac1c578"></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">NONE</span></span></span><a class="headerlink" href="#_CPPv4N5arrow5Datum4Kind4NONEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Datum4Kind6SCALARE"> |
| <span id="_CPPv3N5arrow5Datum4Kind6SCALARE"></span><span id="_CPPv2N5arrow5Datum4Kind6SCALARE"></span><span class="target" id="structarrow_1_1_datum_1aef17d22c0c1f9ca9d4e32a4a914f4d60a49b0ad044f652ddeb924aa341536cdad"></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">SCALAR</span></span></span><a class="headerlink" href="#_CPPv4N5arrow5Datum4Kind6SCALARE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Datum4Kind5ARRAYE"> |
| <span id="_CPPv3N5arrow5Datum4Kind5ARRAYE"></span><span id="_CPPv2N5arrow5Datum4Kind5ARRAYE"></span><span class="target" id="structarrow_1_1_datum_1aef17d22c0c1f9ca9d4e32a4a914f4d60a6109afdc2487d28ec819ef21ad205933"></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">ARRAY</span></span></span><a class="headerlink" href="#_CPPv4N5arrow5Datum4Kind5ARRAYE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Datum4Kind13CHUNKED_ARRAYE"> |
| <span id="_CPPv3N5arrow5Datum4Kind13CHUNKED_ARRAYE"></span><span id="_CPPv2N5arrow5Datum4Kind13CHUNKED_ARRAYE"></span><span class="target" id="structarrow_1_1_datum_1aef17d22c0c1f9ca9d4e32a4a914f4d60aafbdb6bc8776d9aeb53abe138c91afb0"></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">CHUNKED_ARRAY</span></span></span><a class="headerlink" href="#_CPPv4N5arrow5Datum4Kind13CHUNKED_ARRAYE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Datum4Kind12RECORD_BATCHE"> |
| <span id="_CPPv3N5arrow5Datum4Kind12RECORD_BATCHE"></span><span id="_CPPv2N5arrow5Datum4Kind12RECORD_BATCHE"></span><span class="target" id="structarrow_1_1_datum_1aef17d22c0c1f9ca9d4e32a4a914f4d60adb333a80a9ec92346c4d1438e99b2416"></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">RECORD_BATCH</span></span></span><a class="headerlink" href="#_CPPv4N5arrow5Datum4Kind12RECORD_BATCHE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Datum4Kind5TABLEE"> |
| <span id="_CPPv3N5arrow5Datum4Kind5TABLEE"></span><span id="_CPPv2N5arrow5Datum4Kind5TABLEE"></span><span class="target" id="structarrow_1_1_datum_1aef17d22c0c1f9ca9d4e32a4a914f4d60ab864a792cef2859639271feaa766b59d"></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">TABLE</span></span></span><a class="headerlink" href="#_CPPv4N5arrow5Datum4Kind5TABLEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </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="_CPPv4N5arrow5Datum5DatumEv"> |
| <span id="_CPPv3N5arrow5Datum5DatumEv"></span><span id="_CPPv2N5arrow5Datum5DatumEv"></span><span id="arrow::Datum::Datum"></span><span class="target" id="structarrow_1_1_datum_1ac959a8686292debabd50704ab7d7ac37"></span><span class="sig-name descname"><span class="n"><span class="pre">Datum</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="#_CPPv4N5arrow5Datum5DatumEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p><a class="reference internal" href="#structarrow_1_1_datum_1_1_empty"><span class="std std-ref">Empty</span></a> datum, to be populated elsewhere. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Datum5DatumENSt10shared_ptrI6ScalarEE"> |
| <span id="_CPPv3N5arrow5Datum5DatumENSt10shared_ptrI6ScalarEE"></span><span id="_CPPv2N5arrow5Datum5DatumENSt10shared_ptrI6ScalarEE"></span><span id="arrow::Datum::Datum__std::shared_ptr:Scalar:"></span><span class="target" id="structarrow_1_1_datum_1aa35cbca067b0e5bc59e2aafe78663fb7"></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">Datum</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="scalar.html#_CPPv4N5arrow6ScalarE" title="arrow::Scalar"><span class="n"><span class="pre">Scalar</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">value</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow5Datum5DatumENSt10shared_ptrI6ScalarEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Construct from a <a class="reference internal" href="scalar.html#structarrow_1_1_scalar"><span class="std std-ref">Scalar</span></a>. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Datum5DatumENSt10shared_ptrI9ArrayDataEE"> |
| <span id="_CPPv3N5arrow5Datum5DatumENSt10shared_ptrI9ArrayDataEE"></span><span id="_CPPv2N5arrow5Datum5DatumENSt10shared_ptrI9ArrayDataEE"></span><span id="arrow::Datum::Datum__std::shared_ptr:ArrayData:"></span><span class="target" id="structarrow_1_1_datum_1ac07d7bdd2569693922fc7e084e4bd8d6"></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">Datum</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">value</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow5Datum5DatumENSt10shared_ptrI9ArrayDataEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Construct from an <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="_CPPv4N5arrow5Datum5DatumE9ArrayData"> |
| <span id="_CPPv3N5arrow5Datum5DatumE9ArrayData"></span><span id="_CPPv2N5arrow5Datum5DatumE9ArrayData"></span><span id="arrow::Datum::Datum__ArrayData"></span><span class="target" id="structarrow_1_1_datum_1a6e395811441ed1bb30a6221b7bb07e07"></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">Datum</span></span></span><span class="sig-paren">(</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="n sig-param"><span class="pre">arg</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow5Datum5DatumE9ArrayData" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Construct from an <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="_CPPv4N5arrow5Datum5DatumERK5Array"> |
| <span id="_CPPv3N5arrow5Datum5DatumERK5Array"></span><span id="_CPPv2N5arrow5Datum5DatumERK5Array"></span><span id="arrow::Datum::Datum__ArrayCR"></span><span class="target" id="structarrow_1_1_datum_1a634b3888678400cde7fd3e75c27dfac6"></span><span class="sig-name descname"><span class="n"><span class="pre">Datum</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">value</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow5Datum5DatumERK5Array" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Construct from an <a class="reference internal" href="array.html#classarrow_1_1_array"><span class="std std-ref">Array</span></a>. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Datum5DatumERKNSt10shared_ptrI5ArrayEE"> |
| <span id="_CPPv3N5arrow5Datum5DatumERKNSt10shared_ptrI5ArrayEE"></span><span id="_CPPv2N5arrow5Datum5DatumERKNSt10shared_ptrI5ArrayEE"></span><span id="arrow::Datum::Datum__std::shared_ptr:Array:CR"></span><span class="target" id="structarrow_1_1_datum_1a360230fe28ac8ef1b2cde08a12896c4c"></span><span class="sig-name descname"><span class="n"><span class="pre">Datum</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="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">value</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow5Datum5DatumERKNSt10shared_ptrI5ArrayEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Construct from an <a class="reference internal" href="array.html#classarrow_1_1_array"><span class="std std-ref">Array</span></a>. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Datum5DatumENSt10shared_ptrI12ChunkedArrayEE"> |
| <span id="_CPPv3N5arrow5Datum5DatumENSt10shared_ptrI12ChunkedArrayEE"></span><span id="_CPPv2N5arrow5Datum5DatumENSt10shared_ptrI12ChunkedArrayEE"></span><span id="arrow::Datum::Datum__std::shared_ptr:ChunkedArray:"></span><span class="target" id="structarrow_1_1_datum_1aaa89f910a1fe3216d40e7612d8383f3a"></span><span class="sig-name descname"><span class="n"><span class="pre">Datum</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#_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="n sig-param"><span class="pre">value</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow5Datum5DatumENSt10shared_ptrI12ChunkedArrayEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Construct 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="_CPPv4N5arrow5Datum5DatumENSt10shared_ptrI11RecordBatchEE"> |
| <span id="_CPPv3N5arrow5Datum5DatumENSt10shared_ptrI11RecordBatchEE"></span><span id="_CPPv2N5arrow5Datum5DatumENSt10shared_ptrI11RecordBatchEE"></span><span id="arrow::Datum::Datum__std::shared_ptr:RecordBatch:"></span><span class="target" id="structarrow_1_1_datum_1a075e935ffc75db131bfaa6ff3ca6bec3"></span><span class="sig-name descname"><span class="n"><span class="pre">Datum</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="table.html#_CPPv4N5arrow11RecordBatchE" title="arrow::RecordBatch"><span class="n"><span class="pre">RecordBatch</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">value</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow5Datum5DatumENSt10shared_ptrI11RecordBatchEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Construct from a <a class="reference internal" href="table.html#classarrow_1_1_record_batch"><span class="std std-ref">RecordBatch</span></a>. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Datum5DatumENSt10shared_ptrI5TableEE"> |
| <span id="_CPPv3N5arrow5Datum5DatumENSt10shared_ptrI5TableEE"></span><span id="_CPPv2N5arrow5Datum5DatumENSt10shared_ptrI5TableEE"></span><span id="arrow::Datum::Datum__std::shared_ptr:Table:"></span><span class="target" id="structarrow_1_1_datum_1a96370627b5cdff6b2a08d61c9ba60cc3"></span><span class="sig-name descname"><span class="n"><span class="pre">Datum</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="table.html#_CPPv4N5arrow5TableE" title="arrow::Table"><span class="n"><span class="pre">Table</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">value</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow5Datum5DatumENSt10shared_ptrI5TableEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Construct from a <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="_CPPv4N5arrow5Datum5DatumERK12ChunkedArray"> |
| <span id="_CPPv3N5arrow5Datum5DatumERK12ChunkedArray"></span><span id="_CPPv2N5arrow5Datum5DatumERK12ChunkedArray"></span><span id="arrow::Datum::Datum__ChunkedArrayCR"></span><span class="target" id="structarrow_1_1_datum_1ad3b024d1c268c5dccdfa0a660cc8e414"></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">Datum</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">value</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow5Datum5DatumERK12ChunkedArray" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Construct from a <a class="reference internal" href="array.html#classarrow_1_1_chunked_array"><span class="std std-ref">ChunkedArray</span></a>. </p> |
| <p>This can be expensive, prefer the shared_ptr<ChunkedArray> constructor </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Datum5DatumERK11RecordBatch"> |
| <span id="_CPPv3N5arrow5Datum5DatumERK11RecordBatch"></span><span id="_CPPv2N5arrow5Datum5DatumERK11RecordBatch"></span><span id="arrow::Datum::Datum__RecordBatchCR"></span><span class="target" id="structarrow_1_1_datum_1a044353c21d67289ccf0dc51b2248d3c0"></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">Datum</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">value</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow5Datum5DatumERK11RecordBatch" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Construct from a <a class="reference internal" href="table.html#classarrow_1_1_record_batch"><span class="std std-ref">RecordBatch</span></a>. </p> |
| <p>This can be expensive, prefer the shared_ptr<RecordBatch> constructor </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Datum5DatumERK5Table"> |
| <span id="_CPPv3N5arrow5Datum5DatumERK5Table"></span><span id="_CPPv2N5arrow5Datum5DatumERK5Table"></span><span id="arrow::Datum::Datum__TableCR"></span><span class="target" id="structarrow_1_1_datum_1a5a7cfc7c9fe29eea7c7efe5527583303"></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">Datum</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">value</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow5Datum5DatumERK5Table" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Construct from a <a class="reference internal" href="table.html#classarrow_1_1_table"><span class="std std-ref">Table</span></a>. </p> |
| <p>This can be expensive, prefer the shared_ptr<Table> constructor </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4I0_b_b0EN5arrow5Datum5DatumENSt10shared_ptrI1TEE"> |
| <span id="_CPPv3I0_b_b0EN5arrow5Datum5DatumENSt10shared_ptrI1TEE"></span><span id="_CPPv2I0_b_b0EN5arrow5Datum5DatumENSt10shared_ptrI1TEE"></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><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">IsArray</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">is_base_of_v</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><a class="reference internal" href="#_CPPv4I0_b_b0EN5arrow5Datum5DatumENSt10shared_ptrI1TEE" title="arrow::Datum::Datum::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="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">IsScalar</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">is_base_of_v</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="scalar.html#_CPPv4N5arrow6ScalarE" title="arrow::Scalar"><span class="n"><span class="pre">Scalar</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4I0_b_b0EN5arrow5Datum5DatumENSt10shared_ptrI1TEE" title="arrow::Datum::Datum::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="k"><span class="pre">typename</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><a class="reference internal" href="utilities.html#_CPPv4I_b0E11enable_if_t" title="enable_if_t"><span class="n"><span class="pre">enable_if_t</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4I0_b_b0EN5arrow5Datum5DatumENSt10shared_ptrI1TEE" title="arrow::Datum::Datum::IsArray"><span class="n"><span class="pre">IsArray</span></span></a><span class="w"> </span><span class="o"><span class="pre">||</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4I0_b_b0EN5arrow5Datum5DatumENSt10shared_ptrI1TEE" title="arrow::Datum::Datum::IsScalar"><span class="n"><span class="pre">IsScalar</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><br /><span class="target" id="structarrow_1_1_datum_1aee808bac8240ddedbb2d5ba8f6e82ee6"></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">Datum</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="#_CPPv4I0_b_b0EN5arrow5Datum5DatumENSt10shared_ptrI1TEE" title="arrow::Datum::Datum::T"><span class="n"><span class="pre">T</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">value</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4I0_b_b0EN5arrow5Datum5DatumENSt10shared_ptrI1TEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Cast from concrete subtypes of <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="scalar.html#structarrow_1_1_scalar"><span class="std std-ref">Scalar</span></a> to <a class="reference internal" href="#structarrow_1_1_datum"><span class="std std-ref">Datum</span></a>. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4I00_b_b0EN5arrow5Datum5DatumERR1T"> |
| <span id="_CPPv3I00_b_b0EN5arrow5Datum5DatumERR1T"></span><span id="_CPPv2I00_b_b0EN5arrow5Datum5DatumERR1T"></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><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">TV</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">typename</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">remove_reference_t</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4I00_b_b0EN5arrow5Datum5DatumERR1T" title="arrow::Datum::Datum::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="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">IsArray</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">is_base_of_v</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><a class="reference internal" href="#_CPPv4I00_b_b0EN5arrow5Datum5DatumERR1T" title="arrow::Datum::Datum::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="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">IsScalar</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">is_base_of_v</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="scalar.html#_CPPv4N5arrow6ScalarE" title="arrow::Scalar"><span class="n"><span class="pre">Scalar</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4I00_b_b0EN5arrow5Datum5DatumERR1T" title="arrow::Datum::Datum::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="k"><span class="pre">typename</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><a class="reference internal" href="utilities.html#_CPPv4I_b0E11enable_if_t" title="enable_if_t"><span class="n"><span class="pre">enable_if_t</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4I00_b_b0EN5arrow5Datum5DatumERR1T" title="arrow::Datum::Datum::IsArray"><span class="n"><span class="pre">IsArray</span></span></a><span class="w"> </span><span class="o"><span class="pre">||</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4I00_b_b0EN5arrow5Datum5DatumERR1T" title="arrow::Datum::Datum::IsScalar"><span class="n"><span class="pre">IsScalar</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><br /><span class="target" id="structarrow_1_1_datum_1a9798168617d3cb7c4d4a52e94f82e472"></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">Datum</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4I00_b_b0EN5arrow5Datum5DatumERR1T" title="arrow::Datum::Datum::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="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">value</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4I00_b_b0EN5arrow5Datum5DatumERR1T" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Cast from concrete subtypes of <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="scalar.html#structarrow_1_1_scalar"><span class="std std-ref">Scalar</span></a> to <a class="reference internal" href="#structarrow_1_1_datum"><span class="std std-ref">Datum</span></a>. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4I00EN5arrow5Datum5DatumERK1T"> |
| <span id="_CPPv3I00EN5arrow5Datum5DatumERK1T"></span><span id="_CPPv2I00EN5arrow5Datum5DatumERK1T"></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><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="w"> </span><a class="reference internal" href="utilities.html#_CPPv4I_b0E11enable_if_t" title="enable_if_t"><span class="n"><span class="pre">enable_if_t</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">is_base_of_v</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="scalar.html#_CPPv4N5arrow6ScalarE" title="arrow::Scalar"><span class="n"><span class="pre">Scalar</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4I00EN5arrow5Datum5DatumERK1T" title="arrow::Datum::Datum::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><br /><span class="target" id="structarrow_1_1_datum_1a73ca6c1993772de49f7a011eed80a83e"></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">Datum</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="#_CPPv4I00EN5arrow5Datum5DatumERK1T" title="arrow::Datum::Datum::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">value</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4I00EN5arrow5Datum5DatumERK1T" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Copy from concrete subtypes of <a class="reference internal" href="scalar.html#structarrow_1_1_scalar"><span class="std std-ref">Scalar</span></a>. </p> |
| <p>The concrete scalar type must be copyable (not all of them are). </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Datum5DatumEb"> |
| <span id="_CPPv3N5arrow5Datum5DatumEb"></span><span id="_CPPv2N5arrow5Datum5DatumEb"></span><span id="arrow::Datum::Datum__b"></span><span class="target" id="structarrow_1_1_datum_1a14c7918682d1b49a785eb30adbe91ec1"></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">Datum</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">value</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow5Datum5DatumEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Convenience constructor storing a bool scalar. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Datum5DatumE6int8_t"> |
| <span id="_CPPv3N5arrow5Datum5DatumE6int8_t"></span><span id="_CPPv2N5arrow5Datum5DatumE6int8_t"></span><span id="arrow::Datum::Datum__int8_t"></span><span class="target" id="structarrow_1_1_datum_1a3e7a915904cf36972b2a5ab29b144056"></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">Datum</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int8_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">value</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow5Datum5DatumE6int8_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Convenience constructor storing an int8 scalar. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Datum5DatumE7uint8_t"> |
| <span id="_CPPv3N5arrow5Datum5DatumE7uint8_t"></span><span id="_CPPv2N5arrow5Datum5DatumE7uint8_t"></span><span id="arrow::Datum::Datum__uint8_t"></span><span class="target" id="structarrow_1_1_datum_1a03ec1ed12c70fa565f02d3e8507a3533"></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">Datum</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">value</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow5Datum5DatumE7uint8_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Convenience constructor storing a uint8 scalar. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Datum5DatumE7int16_t"> |
| <span id="_CPPv3N5arrow5Datum5DatumE7int16_t"></span><span id="_CPPv2N5arrow5Datum5DatumE7int16_t"></span><span id="arrow::Datum::Datum__int16_t"></span><span class="target" id="structarrow_1_1_datum_1abf3d1cfe70c23b3bf59f588950d7fd28"></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">Datum</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int16_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">value</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow5Datum5DatumE7int16_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Convenience constructor storing an int16 scalar. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Datum5DatumE8uint16_t"> |
| <span id="_CPPv3N5arrow5Datum5DatumE8uint16_t"></span><span id="_CPPv2N5arrow5Datum5DatumE8uint16_t"></span><span id="arrow::Datum::Datum__uint16_t"></span><span class="target" id="structarrow_1_1_datum_1ad7809be575d2e2b8f8ee30d4c633b3e4"></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">Datum</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">uint16_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">value</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow5Datum5DatumE8uint16_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Convenience constructor storing a uint16 scalar. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Datum5DatumE7int32_t"> |
| <span id="_CPPv3N5arrow5Datum5DatumE7int32_t"></span><span id="_CPPv2N5arrow5Datum5DatumE7int32_t"></span><span id="arrow::Datum::Datum__int32_t"></span><span class="target" id="structarrow_1_1_datum_1a62197a8ae7d5dc2f8ece11fa91959352"></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">Datum</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">value</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow5Datum5DatumE7int32_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Convenience constructor storing an int32 scalar. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Datum5DatumE8uint32_t"> |
| <span id="_CPPv3N5arrow5Datum5DatumE8uint32_t"></span><span id="_CPPv2N5arrow5Datum5DatumE8uint32_t"></span><span id="arrow::Datum::Datum__uint32_t"></span><span class="target" id="structarrow_1_1_datum_1a96cf7936ecda29b2cb63896ecec1afe9"></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">Datum</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">uint32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">value</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow5Datum5DatumE8uint32_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Convenience constructor storing a uint32 scalar. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Datum5DatumE7int64_t"> |
| <span id="_CPPv3N5arrow5Datum5DatumE7int64_t"></span><span id="_CPPv2N5arrow5Datum5DatumE7int64_t"></span><span id="arrow::Datum::Datum__int64_t"></span><span class="target" id="structarrow_1_1_datum_1ac056f5694e2c5aa2dc8f66701f6798b8"></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">Datum</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">value</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow5Datum5DatumE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Convenience constructor storing an int64 scalar. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Datum5DatumE8uint64_t"> |
| <span id="_CPPv3N5arrow5Datum5DatumE8uint64_t"></span><span id="_CPPv2N5arrow5Datum5DatumE8uint64_t"></span><span id="arrow::Datum::Datum__uint64_t"></span><span class="target" id="structarrow_1_1_datum_1aa9c8ff559e439ef2e7933b445c2d6d3f"></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">Datum</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">uint64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">value</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow5Datum5DatumE8uint64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Convenience constructor storing a uint64 scalar. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Datum5DatumEf"> |
| <span id="_CPPv3N5arrow5Datum5DatumEf"></span><span id="_CPPv2N5arrow5Datum5DatumEf"></span><span id="arrow::Datum::Datum__float"></span><span class="target" id="structarrow_1_1_datum_1a7d0ef1218e190e7b16399c37b2a9359e"></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">Datum</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">value</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow5Datum5DatumEf" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Convenience constructor storing a float scalar. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Datum5DatumEd"> |
| <span id="_CPPv3N5arrow5Datum5DatumEd"></span><span id="_CPPv2N5arrow5Datum5DatumEd"></span><span id="arrow::Datum::Datum__double"></span><span class="target" id="structarrow_1_1_datum_1a2f708745d022f880e86fdfcfcbea51e8"></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">Datum</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">double</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">value</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow5Datum5DatumEd" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Convenience constructor storing a double scalar. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Datum5DatumENSt6stringE"> |
| <span id="_CPPv3N5arrow5Datum5DatumENSt6stringE"></span><span id="_CPPv2N5arrow5Datum5DatumENSt6stringE"></span><span id="arrow::Datum::Datum__ss"></span><span class="target" id="structarrow_1_1_datum_1a0b9ed3bd3fa9058d27a3c0c2f1b39cc0"></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">Datum</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">value</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow5Datum5DatumENSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Convenience constructor storing a string scalar. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Datum5DatumEPKc"> |
| <span id="_CPPv3N5arrow5Datum5DatumEPKc"></span><span id="_CPPv2N5arrow5Datum5DatumEPKc"></span><span id="arrow::Datum::Datum__cCP"></span><span class="target" id="structarrow_1_1_datum_1ab524c77eba245026ec68016ec7e37c64"></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">Datum</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">value</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow5Datum5DatumEPKc" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Convenience constructor storing a string scalar. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4II00E0000EN5arrow5Datum5DatumE11StdDurationI3Rep6PeriodE"> |
| <span id="_CPPv3II00E0000EN5arrow5Datum5DatumE11StdDurationI3Rep6PeriodE"></span><span id="_CPPv2II00E0000EN5arrow5Datum5DatumE11StdDurationI3Rep6PeriodE"></span><span class="k"><span class="pre">template</span></span><span class="p"><span class="pre"><</span></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="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">typename</span></span><span class="p"><span class="pre">></span></span><span class="w"> </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">StdDuration</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">Rep</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">Period</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="w"> </span><span class="k"><span class="pre">decltype</span></span><span class="p"><span class="pre">(</span></span><a class="reference internal" href="scalar.html#_CPPv4N5arrow14DurationScalarE" title="arrow::DurationScalar"><span class="n"><span class="pre">DurationScalar</span></span></a><span class="p"><span class="pre">{</span></span><a class="reference internal" href="#_CPPv4II00E0000EN5arrow5Datum5DatumE11StdDurationI3Rep6PeriodE" title="arrow::Datum::Datum::StdDuration"><span class="n"><span class="pre">StdDuration</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4II00E0000EN5arrow5Datum5DatumE11StdDurationI3Rep6PeriodE" title="arrow::Datum::Datum::Rep"><span class="n"><span class="pre">Rep</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4II00E0000EN5arrow5Datum5DatumE11StdDurationI3Rep6PeriodE" title="arrow::Datum::Datum::Period"><span class="n"><span class="pre">Period</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="p"><span class="pre">></span></span><br /><span class="target" id="structarrow_1_1_datum_1aa9c872b66f8a0e11996fe523ac8b02f5"></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">Datum</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4II00E0000EN5arrow5Datum5DatumE11StdDurationI3Rep6PeriodE" title="arrow::Datum::Datum::StdDuration"><span class="n"><span class="pre">StdDuration</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4II00E0000EN5arrow5Datum5DatumE11StdDurationI3Rep6PeriodE" title="arrow::Datum::Datum::Rep"><span class="n"><span class="pre">Rep</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4II00E0000EN5arrow5Datum5DatumE11StdDurationI3Rep6PeriodE" title="arrow::Datum::Datum::Period"><span class="n"><span class="pre">Period</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">d</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4II00E0000EN5arrow5Datum5DatumE11StdDurationI3Rep6PeriodE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Convenience constructor for a <a class="reference internal" href="scalar.html#structarrow_1_1_duration_scalar"><span class="std std-ref">DurationScalar</span></a> from std::chrono::duration. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow5Datum4kindEv"> |
| <span id="_CPPv3NK5arrow5Datum4kindEv"></span><span id="_CPPv2NK5arrow5Datum4kindEv"></span><span id="arrow::Datum::kindC"></span><span class="target" id="structarrow_1_1_datum_1a3545454ac3739803724d9f74eff6ff2f"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow5DatumE" title="arrow::Datum"><span class="n"><span class="pre">Datum</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow5Datum4KindE" title="arrow::Datum::Kind"><span class="n"><span class="pre">Kind</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kind</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="#_CPPv4NK5arrow5Datum4kindEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The kind of data stored in <a class="reference internal" href="#structarrow_1_1_datum"><span class="std std-ref">Datum</span></a>. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow5Datum5arrayEv"> |
| <span id="_CPPv3NK5arrow5Datum5arrayEv"></span><span id="_CPPv2NK5arrow5Datum5arrayEv"></span><span id="arrow::Datum::arrayC"></span><span class="target" id="structarrow_1_1_datum_1af82ec66edf6eba31a3f55ea357052979"></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="array.html#_CPPv4N5arrow9ArrayDataE" title="arrow::ArrayData"><span class="n"><span class="pre">ArrayData</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="sig-name descname"><span class="n"><span class="pre">array</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="#_CPPv4NK5arrow5Datum5arrayEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieve the stored array as <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a>. </p> |
| <p>Use <a class="reference internal" href="#structarrow_1_1_datum_1a831cb23cf042b5e41499e0c88c745a29"><span class="std std-ref">make_array()</span></a> if an <a class="reference internal" href="array.html#classarrow_1_1_array"><span class="std std-ref">Array</span></a> is desired (which is more expensive). </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Throws<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><span><span class="cpp-expr sig sig-inline cpp"><span class="n">std</span><span class="p">::</span><span class="n">bad_variant_access</span></span></span> – if the datum is not an array </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow5Datum15TotalBufferSizeEv"> |
| <span id="_CPPv3NK5arrow5Datum15TotalBufferSizeEv"></span><span id="_CPPv2NK5arrow5Datum15TotalBufferSizeEv"></span><span id="arrow::Datum::TotalBufferSizeC"></span><span class="target" id="structarrow_1_1_datum_1ab08b1535bbe91726be389353c159c738"></span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">TotalBufferSize</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="#_CPPv4NK5arrow5Datum15TotalBufferSizeEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The sum of bytes in each buffer referenced by the datum Note: Scalars report a size of 0. </p> |
| <p><div class="admonition seealso"> |
| <p class="admonition-title">See also</p> |
| <p>arrow::util::TotalBufferSize for caveats </p> |
| </div> |
| </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow5Datum13mutable_arrayEv"> |
| <span id="_CPPv3NK5arrow5Datum13mutable_arrayEv"></span><span id="_CPPv2NK5arrow5Datum13mutable_arrayEv"></span><span id="arrow::Datum::mutable_arrayC"></span><span class="target" id="structarrow_1_1_datum_1a38303cd238810b40d4cf705c09a668e4"></span><span class="k"><span class="pre">inline</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="sig-name descname"><span class="n"><span class="pre">mutable_array</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="#_CPPv4NK5arrow5Datum13mutable_arrayEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the stored <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a> in mutable form. </p> |
| <p>For internal use primarily. Keep in mind a shared_ptr<Datum> may have multiple owners. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow5Datum10make_arrayEv"> |
| <span id="_CPPv3NK5arrow5Datum10make_arrayEv"></span><span id="_CPPv2NK5arrow5Datum10make_arrayEv"></span><span id="arrow::Datum::make_arrayC"></span><span class="target" id="structarrow_1_1_datum_1a831cb23cf042b5e41499e0c88c745a29"></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">make_array</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="#_CPPv4NK5arrow5Datum10make_arrayEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieve the stored array as <a class="reference internal" href="array.html#classarrow_1_1_array"><span class="std std-ref">Array</span></a>. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Throws<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><span><span class="cpp-expr sig sig-inline cpp"><span class="n">std</span><span class="p">::</span><span class="n">bad_variant_access</span></span></span> – if the datum is not an array </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow5Datum13chunked_arrayEv"> |
| <span id="_CPPv3NK5arrow5Datum13chunked_arrayEv"></span><span id="_CPPv2NK5arrow5Datum13chunked_arrayEv"></span><span id="arrow::Datum::chunked_arrayC"></span><span class="target" id="structarrow_1_1_datum_1af226e2423009f7f4a298945054120f48"></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="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="sig-name descname"><span class="n"><span class="pre">chunked_array</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="#_CPPv4NK5arrow5Datum13chunked_arrayEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieve the chunked array stored. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Throws<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><span><span class="cpp-expr sig sig-inline cpp"><span class="n">std</span><span class="p">::</span><span class="n">bad_variant_access</span></span></span> – if the datum is not a chunked array </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow5Datum12record_batchEv"> |
| <span id="_CPPv3NK5arrow5Datum12record_batchEv"></span><span id="_CPPv2NK5arrow5Datum12record_batchEv"></span><span id="arrow::Datum::record_batchC"></span><span class="target" id="structarrow_1_1_datum_1acdb9266b0ad9ed7322002baafb4846a8"></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="table.html#_CPPv4N5arrow11RecordBatchE" title="arrow::RecordBatch"><span class="n"><span class="pre">RecordBatch</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="sig-name descname"><span class="n"><span class="pre">record_batch</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="#_CPPv4NK5arrow5Datum12record_batchEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieve the record batch stored. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Throws<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><span><span class="cpp-expr sig sig-inline cpp"><span class="n">std</span><span class="p">::</span><span class="n">bad_variant_access</span></span></span> – if the datum is not a record batch </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow5Datum5tableEv"> |
| <span id="_CPPv3NK5arrow5Datum5tableEv"></span><span id="_CPPv2NK5arrow5Datum5tableEv"></span><span id="arrow::Datum::tableC"></span><span class="target" id="structarrow_1_1_datum_1a6f2a325f67cebaf272e3bcd15a77d9ae"></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="table.html#_CPPv4N5arrow5TableE" title="arrow::Table"><span class="n"><span class="pre">Table</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">table</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="#_CPPv4NK5arrow5Datum5tableEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieve the table stored. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Throws<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><span><span class="cpp-expr sig sig-inline cpp"><span class="n">std</span><span class="p">::</span><span class="n">bad_variant_access</span></span></span> – if the datum is not a table </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow5Datum6scalarEv"> |
| <span id="_CPPv3NK5arrow5Datum6scalarEv"></span><span id="_CPPv2NK5arrow5Datum6scalarEv"></span><span id="arrow::Datum::scalarC"></span><span class="target" id="structarrow_1_1_datum_1afb8155616a321af856474bdabf4d6177"></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="scalar.html#_CPPv4N5arrow6ScalarE" title="arrow::Scalar"><span class="n"><span class="pre">Scalar</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">scalar</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="#_CPPv4NK5arrow5Datum6scalarEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieve the scalar stored. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Throws<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><span><span class="cpp-expr sig sig-inline cpp"><span class="n">std</span><span class="p">::</span><span class="n">bad_variant_access</span></span></span> – if the datum is not a scalar </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4I0ENK5arrow5Datum8array_asENSt10shared_ptrI9ExactTypeEEv"> |
| <span id="_CPPv3I0ENK5arrow5Datum8array_asEv"></span><span id="_CPPv2I0ENK5arrow5Datum8array_asEv"></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">ExactType</span></span></span><span class="p"><span class="pre">></span></span><br /><span class="target" id="structarrow_1_1_datum_1a8a5e94fc6526d33780234ee5fd11fefe"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4I0ENK5arrow5Datum8array_asENSt10shared_ptrI9ExactTypeEEv" title="arrow::Datum::array_as::ExactType"><span class="n"><span class="pre">ExactType</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">array_as</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="#_CPPv4I0ENK5arrow5Datum8array_asENSt10shared_ptrI9ExactTypeEEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieve the datum as its concrete array type. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Throws<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><span><span class="cpp-expr sig sig-inline cpp"><span class="n">std</span><span class="p">::</span><span class="n">bad_variant_access</span></span></span> – if the datum is not an array </p> |
| </dd> |
| <dt class="field-even">Template Parameters<span class="colon">:</span></dt> |
| <dd class="field-even"><p><strong>ExactType</strong> – the expected array type, may cause undefined behavior if it is not the type of the stored array </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4I0ENK5arrow5Datum9scalar_asERK9ExactTypev"> |
| <span id="_CPPv3I0ENK5arrow5Datum9scalar_asEv"></span><span id="_CPPv2I0ENK5arrow5Datum9scalar_asEv"></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">ExactType</span></span></span><span class="p"><span class="pre">></span></span><br /><span class="target" id="structarrow_1_1_datum_1a53f8dd9412b635b9d64357cda0e3ff7e"></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="#_CPPv4I0ENK5arrow5Datum9scalar_asERK9ExactTypev" title="arrow::Datum::scalar_as::ExactType"><span class="n"><span class="pre">ExactType</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">scalar_as</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="#_CPPv4I0ENK5arrow5Datum9scalar_asERK9ExactTypev" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieve the datum as its concrete scalar type. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Throws<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><span><span class="cpp-expr sig sig-inline cpp"><span class="n">std</span><span class="p">::</span><span class="n">bad_variant_access</span></span></span> – if the datum is not a scalar </p> |
| </dd> |
| <dt class="field-even">Template Parameters<span class="colon">:</span></dt> |
| <dd class="field-even"><p><strong>ExactType</strong> – the expected scalar type, may cause undefined behavior if it is not the type of the stored scalar </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow5Datum8is_arrayEv"> |
| <span id="_CPPv3NK5arrow5Datum8is_arrayEv"></span><span id="_CPPv2NK5arrow5Datum8is_arrayEv"></span><span id="arrow::Datum::is_arrayC"></span><span class="target" id="structarrow_1_1_datum_1a8443fbdf9da8f545262c10ca4609777d"></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_array</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="#_CPPv4NK5arrow5Datum8is_arrayEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>True if <a class="reference internal" href="#structarrow_1_1_datum"><span class="std std-ref">Datum</span></a> contains an array. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow5Datum16is_chunked_arrayEv"> |
| <span id="_CPPv3NK5arrow5Datum16is_chunked_arrayEv"></span><span id="_CPPv2NK5arrow5Datum16is_chunked_arrayEv"></span><span id="arrow::Datum::is_chunked_arrayC"></span><span class="target" id="structarrow_1_1_datum_1a2b5184fb5d4048933cfe7cfd5a5aa415"></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_chunked_array</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="#_CPPv4NK5arrow5Datum16is_chunked_arrayEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>True if <a class="reference internal" href="#structarrow_1_1_datum"><span class="std std-ref">Datum</span></a> contains a chunked array. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow5Datum12is_arraylikeEv"> |
| <span id="_CPPv3NK5arrow5Datum12is_arraylikeEv"></span><span id="_CPPv2NK5arrow5Datum12is_arraylikeEv"></span><span id="arrow::Datum::is_arraylikeC"></span><span class="target" id="structarrow_1_1_datum_1a85ff430b4e01292d03f4e5e2160be3da"></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_arraylike</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="#_CPPv4NK5arrow5Datum12is_arraylikeEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>True if <a class="reference internal" href="#structarrow_1_1_datum"><span class="std std-ref">Datum</span></a> contains an array or a chunked array. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow5Datum9is_scalarEv"> |
| <span id="_CPPv3NK5arrow5Datum9is_scalarEv"></span><span id="_CPPv2NK5arrow5Datum9is_scalarEv"></span><span id="arrow::Datum::is_scalarC"></span><span class="target" id="structarrow_1_1_datum_1ab9ec20cda4d9078f5dbff82e4af514b7"></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_scalar</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="#_CPPv4NK5arrow5Datum9is_scalarEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>True if <a class="reference internal" href="#structarrow_1_1_datum"><span class="std std-ref">Datum</span></a> contains a scalar. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow5Datum8is_valueEv"> |
| <span id="_CPPv3NK5arrow5Datum8is_valueEv"></span><span id="_CPPv2NK5arrow5Datum8is_valueEv"></span><span id="arrow::Datum::is_valueC"></span><span class="target" id="structarrow_1_1_datum_1a9bda320ace697bae8e7f45167dcf3b02"></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_value</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="#_CPPv4NK5arrow5Datum8is_valueEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>True if <a class="reference internal" href="#structarrow_1_1_datum"><span class="std std-ref">Datum</span></a> contains a scalar or array-like data. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow5Datum10null_countEv"> |
| <span id="_CPPv3NK5arrow5Datum10null_countEv"></span><span id="_CPPv2NK5arrow5Datum10null_countEv"></span><span id="arrow::Datum::null_countC"></span><span class="target" id="structarrow_1_1_datum_1a59f7496699031e70467d54c8a7b16348"></span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">null_count</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="#_CPPv4NK5arrow5Datum10null_countEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the null count. </p> |
| <p>Only valid for scalar and array-like data. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow5Datum4typeEv"> |
| <span id="_CPPv3NK5arrow5Datum4typeEv"></span><span id="_CPPv2NK5arrow5Datum4typeEv"></span><span id="arrow::Datum::typeC"></span><span class="target" id="structarrow_1_1_datum_1aedacf89fffdd049f12caf6089a9b52f7"></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow8DataTypeE" title="arrow::DataType"><span class="n"><span class="pre">DataType</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="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="#_CPPv4NK5arrow5Datum4typeEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The value type of the variant, if any. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>nullptr if no type </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow5Datum6schemaEv"> |
| <span id="_CPPv3NK5arrow5Datum6schemaEv"></span><span id="_CPPv2NK5arrow5Datum6schemaEv"></span><span id="arrow::Datum::schemaC"></span><span class="target" id="structarrow_1_1_datum_1afa12dd9444bb20260a761821ac39e469"></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow6SchemaE" title="arrow::Schema"><span class="n"><span class="pre">Schema</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="sig-name descname"><span class="n"><span class="pre">schema</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow5Datum6schemaEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The schema of the variant, if any. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>nullptr if no schema </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow5Datum6lengthEv"> |
| <span id="_CPPv3NK5arrow5Datum6lengthEv"></span><span id="_CPPv2NK5arrow5Datum6lengthEv"></span><span id="arrow::Datum::lengthC"></span><span class="target" id="structarrow_1_1_datum_1a763b39eb83b2b01490b12c393edd12a2"></span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">length</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow5Datum6lengthEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The value length of the variant, if any. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>kUnknownLength if no type </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow5Datum6chunksEv"> |
| <span id="_CPPv3NK5arrow5Datum6chunksEv"></span><span id="_CPPv2NK5arrow5Datum6chunksEv"></span><span id="arrow::Datum::chunksC"></span><span class="target" id="structarrow_1_1_datum_1a01629b9b33d60f397cc9c3a4731d7f0f"></span><span class="n"><span class="pre">ArrayVector</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">chunks</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="#_CPPv4NK5arrow5Datum6chunksEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The array chunks of the variant, if any. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>empty if not arraylike </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow5Datum6EqualsERK5Datum"> |
| <span id="_CPPv3NK5arrow5Datum6EqualsERK5Datum"></span><span id="_CPPv2NK5arrow5Datum6EqualsERK5Datum"></span><span id="arrow::Datum::Equals__DatumCRC"></span><span class="target" id="structarrow_1_1_datum_1abb1baa1de57f9177b2d72957c9e8dc6c"></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="#_CPPv4N5arrow5DatumE" title="arrow::Datum"><span class="n"><span class="pre">Datum</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="#_CPPv4NK5arrow5Datum6EqualsERK5Datum" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>True if the two data are equal. </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="_CPPv4N5arrow5Datum5valueE"> |
| <span id="_CPPv3N5arrow5Datum5valueE"></span><span id="_CPPv2N5arrow5Datum5valueE"></span><span id="arrow::Datum::value__std::variant:Empty.std::shared_ptr:Scalar:.std::shared_ptr:ArrayData:.std::shared_ptr:ChunkedArray:.std::shared_ptr:RecordBatch:.std::shared_ptr:Table::"></span><span class="target" id="structarrow_1_1_datum_1a8a9aec413f9aba8383423b56b029cfb1"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">variant</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow5Datum5EmptyE" title="arrow::Datum::Empty"><span class="n"><span class="pre">Empty</span></span></a><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><a class="reference internal" href="scalar.html#_CPPv4N5arrow6ScalarE" title="arrow::Scalar"><span class="n"><span class="pre">Scalar</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">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="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="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="table.html#_CPPv4N5arrow11RecordBatchE" title="arrow::RecordBatch"><span class="n"><span class="pre">RecordBatch</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="table.html#_CPPv4N5arrow5TableE" title="arrow::Table"><span class="n"><span class="pre">Table</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">value</span></span></span><a class="headerlink" href="#_CPPv4N5arrow5Datum5valueE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Storage of the actual datum. </p> |
| <p>Note: For arrays, <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a> is stored instead of <a class="reference internal" href="array.html#classarrow_1_1_array"><span class="std std-ref">Array</span></a> for easier processing </p> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-static-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Datum14kUnknownLengthE"> |
| <span id="_CPPv3N5arrow5Datum14kUnknownLengthE"></span><span id="_CPPv2N5arrow5Datum14kUnknownLengthE"></span><span id="arrow::Datum::kUnknownLength__int64_t"></span><span class="target" id="structarrow_1_1_datum_1af22aadc671c13c67cd9a1d6922bc35dd"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kUnknownLength</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="o"><span class="pre">-</span></span><span class="m"><span class="pre">1</span></span><a class="headerlink" href="#_CPPv4N5arrow5Datum14kUnknownLengthE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Datums variants may have a length. </p> |
| <p>This special value indicate that the current variant does not have a length. </p> |
| </dd></dl> |
| |
| </div> |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Datum5EmptyE"> |
| <span id="_CPPv3N5arrow5Datum5EmptyE"></span><span id="_CPPv2N5arrow5Datum5EmptyE"></span><span id="arrow::Datum::Empty"></span><span class="target" id="structarrow_1_1_datum_1_1_empty"></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">Empty</span></span></span><a class="headerlink" href="#_CPPv4N5arrow5Datum5EmptyE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A placeholder type to represent empty datum. </p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| </section> |
| <section id="abstract-function-classes"> |
| <h2>Abstract Function classes<a class="headerlink" href="#abstract-function-classes" title="Permalink to this heading">#</a></h2> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv47PrintToRK15FunctionOptionsPNSt7ostreamE"> |
| <span id="_CPPv37PrintToRK15FunctionOptionsPNSt7ostreamE"></span><span id="_CPPv27PrintToRK15FunctionOptionsPNSt7ostreamE"></span><span id="PrintTo__FunctionOptionsCR.osP"></span><span class="target" id="group__compute-functions_1gaf25845828f5529e81f40705864b7ba31"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PrintTo</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">FunctionOptions</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">ostream</span></span><span class="p"><span class="pre">*</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv47PrintToRK15FunctionOptionsPNSt7ostreamE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute5ArityE"> |
| <span id="_CPPv3N5arrow7compute5ArityE"></span><span id="_CPPv2N5arrow7compute5ArityE"></span><span id="arrow::compute::Arity"></span><span class="target" id="structarrow_1_1compute_1_1_arity"></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">Arity</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute5ArityE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/function.h></em></div> |
| <p>Contains the number of required arguments for the function. </p> |
| <p>Naming conventions taken from <a class="reference external" href="https://en.wikipedia.org/wiki/Arity">https://en.wikipedia.org/wiki/Arity</a>. </p> |
| <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="_CPPv4N5arrow7compute5Arity8num_argsE"> |
| <span id="_CPPv3N5arrow7compute5Arity8num_argsE"></span><span id="_CPPv2N5arrow7compute5Arity8num_argsE"></span><span id="arrow::compute::Arity::num_args__i"></span><span class="target" id="structarrow_1_1compute_1_1_arity_1ac0835210a3ccbdb9dc03656cd227a3a4"></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_args</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute5Arity8num_argsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The number of required arguments (or the minimum number for varargs functions). </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute5Arity10is_varargsE"> |
| <span id="_CPPv3N5arrow7compute5Arity10is_varargsE"></span><span id="_CPPv2N5arrow7compute5Arity10is_varargsE"></span><span id="arrow::compute::Arity::is_varargs__b"></span><span class="target" id="structarrow_1_1compute_1_1_arity_1a97e8c95d884704dca164b31954f1790a"></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_varargs</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="#_CPPv4N5arrow7compute5Arity10is_varargsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>If true, then the num_args is the minimum number of required arguments. </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="_CPPv4N5arrow7compute5Arity7NullaryEv"> |
| <span id="_CPPv3N5arrow7compute5Arity7NullaryEv"></span><span id="_CPPv2N5arrow7compute5Arity7NullaryEv"></span><span id="arrow::compute::Arity::Nullary"></span><span class="target" id="structarrow_1_1compute_1_1_arity_1a9a45beefddb0ae8cd09e6cb04c539c94"></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="#_CPPv4N5arrow7compute5ArityE" title="arrow::compute::Arity"><span class="n"><span class="pre">Arity</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Nullary</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute5Arity7NullaryEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A function taking no arguments. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute5Arity5UnaryEv"> |
| <span id="_CPPv3N5arrow7compute5Arity5UnaryEv"></span><span id="_CPPv2N5arrow7compute5Arity5UnaryEv"></span><span id="arrow::compute::Arity::Unary"></span><span class="target" id="structarrow_1_1compute_1_1_arity_1aec7c0ceb939466501712eb0f6ce66c4e"></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="#_CPPv4N5arrow7compute5ArityE" title="arrow::compute::Arity"><span class="n"><span class="pre">Arity</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Unary</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute5Arity5UnaryEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A function taking 1 argument. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute5Arity6BinaryEv"> |
| <span id="_CPPv3N5arrow7compute5Arity6BinaryEv"></span><span id="_CPPv2N5arrow7compute5Arity6BinaryEv"></span><span id="arrow::compute::Arity::Binary"></span><span class="target" id="structarrow_1_1compute_1_1_arity_1a9440de14911ec9898a2106fc0d18ebc3"></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="#_CPPv4N5arrow7compute5ArityE" title="arrow::compute::Arity"><span class="n"><span class="pre">Arity</span></span></a><span class="w"> </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="#_CPPv4N5arrow7compute5Arity6BinaryEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A function taking 2 arguments. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute5Arity7TernaryEv"> |
| <span id="_CPPv3N5arrow7compute5Arity7TernaryEv"></span><span id="_CPPv2N5arrow7compute5Arity7TernaryEv"></span><span id="arrow::compute::Arity::Ternary"></span><span class="target" id="structarrow_1_1compute_1_1_arity_1a785cedddcdf97bf69b05fc5d373b6efe"></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="#_CPPv4N5arrow7compute5ArityE" title="arrow::compute::Arity"><span class="n"><span class="pre">Arity</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Ternary</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute5Arity7TernaryEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A function taking 3 arguments. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute5Arity7VarArgsEi"> |
| <span id="_CPPv3N5arrow7compute5Arity7VarArgsEi"></span><span id="_CPPv2N5arrow7compute5Arity7VarArgsEi"></span><span id="arrow::compute::Arity::VarArgs__i"></span><span class="target" id="structarrow_1_1compute_1_1_arity_1a3107e63bae6daa152342c0c6ded8499b"></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="#_CPPv4N5arrow7compute5ArityE" title="arrow::compute::Arity"><span class="n"><span class="pre">Arity</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">VarArgs</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">min_args</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><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute5Arity7VarArgsEi" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A function taking a variable number of arguments. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>min_args</strong> – <strong>[in]</strong> the minimum number of arguments required when invoking the function </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11FunctionDocE"> |
| <span id="_CPPv3N5arrow7compute11FunctionDocE"></span><span id="_CPPv2N5arrow7compute11FunctionDocE"></span><span id="arrow::compute::FunctionDoc"></span><span class="target" id="structarrow_1_1compute_1_1_function_doc"></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">FunctionDoc</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11FunctionDocE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/function.h></em></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="_CPPv4N5arrow7compute11FunctionDoc7summaryE"> |
| <span id="_CPPv3N5arrow7compute11FunctionDoc7summaryE"></span><span id="_CPPv2N5arrow7compute11FunctionDoc7summaryE"></span><span id="arrow::compute::FunctionDoc::summary__ss"></span><span class="target" id="structarrow_1_1compute_1_1_function_doc_1aba356492dc684518e6bea4583ade414b"></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">summary</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11FunctionDoc7summaryE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A one-line summary of the function, using a verb. </p> |
| <p>For example, “Add two numeric arrays or scalars”. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11FunctionDoc11descriptionE"> |
| <span id="_CPPv3N5arrow7compute11FunctionDoc11descriptionE"></span><span id="_CPPv2N5arrow7compute11FunctionDoc11descriptionE"></span><span id="arrow::compute::FunctionDoc::description__ss"></span><span class="target" id="structarrow_1_1compute_1_1_function_doc_1a3e0c1b927490d1f55f68b6d3dba11218"></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">description</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11FunctionDoc11descriptionE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A detailed description of the function, meant to follow the summary. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11FunctionDoc9arg_namesE"> |
| <span id="_CPPv3N5arrow7compute11FunctionDoc9arg_namesE"></span><span id="_CPPv2N5arrow7compute11FunctionDoc9arg_namesE"></span><span id="arrow::compute::FunctionDoc::arg_names__std::vector:ss:"></span><span class="target" id="structarrow_1_1compute_1_1_function_doc_1a251f1a10e0a7cfedb1739cc26179189c"></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="sig-name descname"><span class="n"><span class="pre">arg_names</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11FunctionDoc9arg_namesE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Symbolic names (identifiers) for the function arguments. </p> |
| <p>Some bindings may use this to generate nicer function signatures. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11FunctionDoc13options_classE"> |
| <span id="_CPPv3N5arrow7compute11FunctionDoc13options_classE"></span><span id="_CPPv2N5arrow7compute11FunctionDoc13options_classE"></span><span id="arrow::compute::FunctionDoc::options_class__ss"></span><span class="target" id="structarrow_1_1compute_1_1_function_doc_1a91f553a4e25b39686d1869913c9b3d9d"></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">options_class</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11FunctionDoc13options_classE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Name of the options class, if any. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11FunctionDoc16options_requiredE"> |
| <span id="_CPPv3N5arrow7compute11FunctionDoc16options_requiredE"></span><span id="_CPPv2N5arrow7compute11FunctionDoc16options_requiredE"></span><span id="arrow::compute::FunctionDoc::options_required__b"></span><span class="target" id="structarrow_1_1compute_1_1_function_doc_1a710423e3d3ff687206c8e69213b045b5"></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">options_required</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11FunctionDoc16options_requiredE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Whether options are required for function execution. </p> |
| <p>If false, then either the function does not have an options class or there is a usable default options value. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16FunctionExecutorE"> |
| <span id="_CPPv3N5arrow7compute16FunctionExecutorE"></span><span id="_CPPv2N5arrow7compute16FunctionExecutorE"></span><span id="arrow::compute::FunctionExecutor"></span><span class="target" id="classarrow_1_1compute_1_1_function_executor"></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">FunctionExecutor</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute16FunctionExecutorE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/function.h></em></div> |
| <p>An executor of a function with a preconfigured kernel. </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="_CPPv4N5arrow7compute16FunctionExecutor4InitEPK15FunctionOptionsP11ExecContext"> |
| <span id="_CPPv3N5arrow7compute16FunctionExecutor4InitEPK15FunctionOptionsP11ExecContext"></span><span id="_CPPv2N5arrow7compute16FunctionExecutor4InitEPK15FunctionOptionsP11ExecContext"></span><span id="arrow::compute::FunctionExecutor::Init__FunctionOptionsCP.ExecContextP"></span><span class="target" id="classarrow_1_1compute_1_1_function_executor_1a49d3290e60c37c83d1657c399d79e20f"></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">Init</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="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></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><span class="n"><span class="pre">NULLPTR</span></span>, <span class="n"><span class="pre">ExecContext</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">exec_ctx</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="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute16FunctionExecutor4InitEPK15FunctionOptionsP11ExecContext" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Initialize or re-initialize the preconfigured kernel. </p> |
| <p>This method may be called zero or more times. Depending on how the <a class="reference internal" href="#classarrow_1_1compute_1_1_function_executor"><span class="std std-ref">FunctionExecutor</span></a> was obtained, it may already have been initialized. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16FunctionExecutor7ExecuteERKNSt6vectorI5DatumEE7int64_t"> |
| <span id="_CPPv3N5arrow7compute16FunctionExecutor7ExecuteERKNSt6vectorI5DatumEE7int64_t"></span><span id="_CPPv2N5arrow7compute16FunctionExecutor7ExecuteERKNSt6vectorI5DatumEE7int64_t"></span><span id="arrow::compute::FunctionExecutor::Execute__std::vector:Datum:CR.int64_t"></span><span class="target" id="classarrow_1_1compute_1_1_function_executor_1a0106bbe9e576835f1fd1aa868abfe2d9"></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><a class="reference internal" href="#_CPPv4N5arrow5DatumE" title="arrow::Datum"><span class="n"><span class="pre">Datum</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">Execute</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="#_CPPv4N5arrow5DatumE" title="arrow::Datum"><span class="n"><span class="pre">Datum</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">args</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="o"><span class="pre">-</span></span><span class="m"><span class="pre">1</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute16FunctionExecutor7ExecuteERKNSt6vectorI5DatumEE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Execute the preconfigured kernel with arguments that must fit it. </p> |
| <p>The method requires the arguments be castable to the preconfigured types.</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>args</strong> – <strong>[in]</strong> Arguments to execute the function on </p></li> |
| <li><p><strong>length</strong> – <strong>[in]</strong> Length of arguments batch or -1 to default it. If the function has no parameters, this determines the batch length, defaulting to 0. Otherwise, if the function is scalar, this must equal the argument batch’s inferred length or be -1 to default to it. This is ignored for vector functions. </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute8FunctionE"> |
| <span id="_CPPv3N5arrow7compute8FunctionE"></span><span id="_CPPv2N5arrow7compute8FunctionE"></span><span id="arrow::compute::Function"></span><span class="target" id="classarrow_1_1compute_1_1_function"></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">Function</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute8FunctionE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/function.h></em></div> |
| <p>Base class for compute functions. </p> |
| <p><a class="reference internal" href="#classarrow_1_1compute_1_1_function"><span class="std std-ref">Function</span></a> implementations contain a collection of “kernels” which are implementations of the function for specific argument types. Selecting a viable kernel for executing a function is referred to as “dispatching”. </p> |
| <p>Subclassed by arrow::compute::detail::FunctionImpl< VectorKernel >, arrow::compute::detail::FunctionImpl< ScalarKernel >, arrow::compute::detail::FunctionImpl< ScalarAggregateKernel >, arrow::compute::detail::FunctionImpl< HashAggregateKernel >, <a class="reference internal" href="#classarrow_1_1compute_1_1_meta_function"><span class="std std-ref">arrow::compute::MetaFunction</span></a>, arrow::compute::detail::FunctionImpl< KernelType ></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 enum"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute8Function4KindE"> |
| <span id="_CPPv3N5arrow7compute8Function4KindE"></span><span id="_CPPv2N5arrow7compute8Function4KindE"></span><span class="target" id="classarrow_1_1compute_1_1_function_1a0fd48810bd747bc9c0d3dd231af7e1c0"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Kind</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute8Function4KindE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The kind of function, which indicates in what contexts it is valid for use. </p> |
| <p><em>Values:</em></p> |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute8Function4Kind6SCALARE"> |
| <span id="_CPPv3N5arrow7compute8Function4Kind6SCALARE"></span><span id="_CPPv2N5arrow7compute8Function4Kind6SCALARE"></span><span class="target" id="classarrow_1_1compute_1_1_function_1a0fd48810bd747bc9c0d3dd231af7e1c0a8d9d161ef844ba33706491803fe3a47d"></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">SCALAR</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute8Function4Kind6SCALARE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A function that performs scalar data operations on whole arrays of data. </p> |
| <p>Can generally process <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="scalar.html#structarrow_1_1_scalar"><span class="std std-ref">Scalar</span></a> values. The size of the output will be the same as the size (or broadcasted size, in the case of mixing <a class="reference internal" href="array.html#classarrow_1_1_array"><span class="std std-ref">Array</span></a> and <a class="reference internal" href="scalar.html#structarrow_1_1_scalar"><span class="std std-ref">Scalar</span></a> inputs) of the input. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute8Function4Kind6VECTORE"> |
| <span id="_CPPv3N5arrow7compute8Function4Kind6VECTORE"></span><span id="_CPPv2N5arrow7compute8Function4Kind6VECTORE"></span><span class="target" id="classarrow_1_1compute_1_1_function_1a0fd48810bd747bc9c0d3dd231af7e1c0a9c16c3e7234aa7f8dd5f2da4b4a2177d"></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">VECTOR</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute8Function4Kind6VECTORE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A function with array input and output whose behavior depends on the values of the entire arrays passed, rather than the value of each scalar value. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute8Function4Kind16SCALAR_AGGREGATEE"> |
| <span id="_CPPv3N5arrow7compute8Function4Kind16SCALAR_AGGREGATEE"></span><span id="_CPPv2N5arrow7compute8Function4Kind16SCALAR_AGGREGATEE"></span><span class="target" id="classarrow_1_1compute_1_1_function_1a0fd48810bd747bc9c0d3dd231af7e1c0a7158dc1574333f45a8cd057dd3301f2f"></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">SCALAR_AGGREGATE</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute8Function4Kind16SCALAR_AGGREGATEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A function that computes scalar summary statistics from array input. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute8Function4Kind14HASH_AGGREGATEE"> |
| <span id="_CPPv3N5arrow7compute8Function4Kind14HASH_AGGREGATEE"></span><span id="_CPPv2N5arrow7compute8Function4Kind14HASH_AGGREGATEE"></span><span class="target" id="classarrow_1_1compute_1_1_function_1a0fd48810bd747bc9c0d3dd231af7e1c0afee2c949d66a7e48e9a01f3a702b0848"></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">HASH_AGGREGATE</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute8Function4Kind14HASH_AGGREGATEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A function that computes grouped summary statistics from array input and an array of group identifiers. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute8Function4Kind4METAE"> |
| <span id="_CPPv3N5arrow7compute8Function4Kind4METAE"></span><span id="_CPPv2N5arrow7compute8Function4Kind4METAE"></span><span class="target" id="classarrow_1_1compute_1_1_function_1a0fd48810bd747bc9c0d3dd231af7e1c0ac353f0c9f07b16f3d2edbc23090401f0"></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">META</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute8Function4Kind4METAE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A function that dispatches to other functions and does not contain its own kernels. </p> |
| </dd></dl> |
| |
| </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="_CPPv4NK5arrow7compute8Function4nameEv"> |
| <span id="_CPPv3NK5arrow7compute8Function4nameEv"></span><span id="_CPPv2NK5arrow7compute8Function4nameEv"></span><span id="arrow::compute::Function::nameC"></span><span class="target" id="classarrow_1_1compute_1_1_function_1a9b88663f5bcbc9f902cfca45b6f424c8"></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="#_CPPv4NK5arrow7compute8Function4nameEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The name of the kernel. The registry enforces uniqueness of names. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow7compute8Function4kindEv"> |
| <span id="_CPPv3NK5arrow7compute8Function4kindEv"></span><span id="_CPPv2NK5arrow7compute8Function4kindEv"></span><span id="arrow::compute::Function::kindC"></span><span class="target" id="classarrow_1_1compute_1_1_function_1abed2b4eef28cdc119c155e8823408ac9"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow7compute8FunctionE" title="arrow::compute::Function"><span class="n"><span class="pre">Function</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute8Function4KindE" title="arrow::compute::Function::Kind"><span class="n"><span class="pre">Kind</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kind</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="#_CPPv4NK5arrow7compute8Function4kindEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The kind of kernel, which indicates in what contexts it is valid for use. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow7compute8Function5arityEv"> |
| <span id="_CPPv3NK5arrow7compute8Function5arityEv"></span><span id="_CPPv2NK5arrow7compute8Function5arityEv"></span><span id="arrow::compute::Function::arityC"></span><span class="target" id="classarrow_1_1compute_1_1_function_1ad3f2371371c68b5850dcb1df5e16502f"></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="#_CPPv4N5arrow7compute5ArityE" title="arrow::compute::Arity"><span class="n"><span class="pre">Arity</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">arity</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="#_CPPv4NK5arrow7compute8Function5arityEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Contains the number of arguments the function requires, or if the function accepts variable numbers of arguments. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow7compute8Function3docEv"> |
| <span id="_CPPv3NK5arrow7compute8Function3docEv"></span><span id="_CPPv2NK5arrow7compute8Function3docEv"></span><span id="arrow::compute::Function::docC"></span><span class="target" id="classarrow_1_1compute_1_1_function_1aadfe552c86a5228338c1cb11e4de6e07"></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="#_CPPv4N5arrow7compute11FunctionDocE" title="arrow::compute::FunctionDoc"><span class="n"><span class="pre">FunctionDoc</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">doc</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="#_CPPv4NK5arrow7compute8Function3docEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the function documentation. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow7compute8Function11num_kernelsEv"> |
| <span id="_CPPv3NK5arrow7compute8Function11num_kernelsEv"></span><span id="_CPPv2NK5arrow7compute8Function11num_kernelsEv"></span><span id="arrow::compute::Function::num_kernelsC"></span><span class="target" id="classarrow_1_1compute_1_1_function_1ac88a594c6541ae1f86c3256a85200d51"></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">num_kernels</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="#_CPPv4NK5arrow7compute8Function11num_kernelsEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Returns the number of registered kernels for this function. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow7compute8Function13DispatchExactERKNSt6vectorI10TypeHolderEE"> |
| <span id="_CPPv3NK5arrow7compute8Function13DispatchExactERKNSt6vectorI10TypeHolderEE"></span><span id="_CPPv2NK5arrow7compute8Function13DispatchExactERKNSt6vectorI10TypeHolderEE"></span><span id="arrow::compute::Function::DispatchExact__std::vector:TypeHolder:CRC"></span><span class="target" id="classarrow_1_1compute_1_1_function_1a637a03baa82de8bd000a6fdf2368d3c9"></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="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">Kernel</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">DispatchExact</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">TypeHolder</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">types</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow7compute8Function13DispatchExactERKNSt6vectorI10TypeHolderEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return a kernel that can execute the function given the exact argument types (without implicit type casts). </p> |
| <p>NB: This function is overridden in CastFunction. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow7compute8Function12DispatchBestEPNSt6vectorI10TypeHolderEE"> |
| <span id="_CPPv3NK5arrow7compute8Function12DispatchBestEPNSt6vectorI10TypeHolderEE"></span><span id="_CPPv2NK5arrow7compute8Function12DispatchBestEPNSt6vectorI10TypeHolderEE"></span><span id="arrow::compute::Function::DispatchBest__std::vector:TypeHolder:PC"></span><span class="target" id="classarrow_1_1compute_1_1_function_1a0ca7cfaaa3a8d53d35b40cdedfe3dd94"></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="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">Kernel</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">DispatchBest</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="n"><span class="pre">TypeHolder</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">values</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow7compute8Function12DispatchBestEPNSt6vectorI10TypeHolderEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return a best-match kernel that can execute the function given the argument types, after implicit casts are applied. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>values</strong> – <strong>[inout]</strong> Argument types. An element may be modified to indicate that the returned kernel only approximately matches the input value descriptors; callers are responsible for casting inputs to the type required by the kernel. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow7compute8Function15GetBestExecutorENSt6vectorI10TypeHolderEE"> |
| <span id="_CPPv3NK5arrow7compute8Function15GetBestExecutorENSt6vectorI10TypeHolderEE"></span><span id="_CPPv2NK5arrow7compute8Function15GetBestExecutorENSt6vectorI10TypeHolderEE"></span><span id="arrow::compute::Function::GetBestExecutor__std::vector:TypeHolder:C"></span><span class="target" id="classarrow_1_1compute_1_1_function_1a093de220bd1264a479e8f573d17f29ee"></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="#_CPPv4N5arrow7compute16FunctionExecutorE" title="arrow::compute::FunctionExecutor"><span class="n"><span class="pre">FunctionExecutor</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">GetBestExecutor</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="n"><span class="pre">TypeHolder</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">inputs</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow7compute8Function15GetBestExecutorENSt6vectorI10TypeHolderEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get a function executor with a best-matching kernel. </p> |
| <p>The returned executor will by default work with the default <a class="reference internal" href="#classarrow_1_1compute_1_1_function_options"><span class="std std-ref">FunctionOptions</span></a> and KernelContext. If you want to change that, call <code class="docutils literal notranslate"><a class="reference internal" href="#classarrow_1_1compute_1_1_function_executor_1a49d3290e60c37c83d1657c399d79e20f"><span class="std std-ref"><span class="pre">FunctionExecutor::Init</span></span></a></code>. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow7compute8Function7ExecuteERKNSt6vectorI5DatumEEPK15FunctionOptionsP11ExecContext"> |
| <span id="_CPPv3NK5arrow7compute8Function7ExecuteERKNSt6vectorI5DatumEEPK15FunctionOptionsP11ExecContext"></span><span id="_CPPv2NK5arrow7compute8Function7ExecuteERKNSt6vectorI5DatumEEPK15FunctionOptionsP11ExecContext"></span><span id="arrow::compute::Function::Execute__std::vector:Datum:CR.FunctionOptionsCP.ExecContextPC"></span><span class="target" id="classarrow_1_1compute_1_1_function_1ae8bf178b183e307edefadb2614fa53da"></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><a class="reference internal" href="#_CPPv4N5arrow5DatumE" title="arrow::Datum"><span class="n"><span class="pre">Datum</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">Execute</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="#_CPPv4N5arrow5DatumE" title="arrow::Datum"><span class="n"><span class="pre">Datum</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">args</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="n"><span class="pre">ExecContext</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">ctx</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow7compute8Function7ExecuteERKNSt6vectorI5DatumEEPK15FunctionOptionsP11ExecContext" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Execute the function eagerly with the passed input arguments with kernel dispatch, batch iteration, and memory allocation details taken care of. </p> |
| <p>If the <code class="docutils literal notranslate"><span class="pre">options</span></code> pointer is null, then <code class="docutils literal notranslate"><a class="reference internal" href="#classarrow_1_1compute_1_1_function_1a19eb16cff543de56016df5883c316e8c"><span class="std std-ref"><span class="pre">default_options()</span></span></a></code> will be used.</p> |
| <p>This function can be overridden in subclasses. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow7compute8Function15default_optionsEv"> |
| <span id="_CPPv3NK5arrow7compute8Function15default_optionsEv"></span><span id="_CPPv2NK5arrow7compute8Function15default_optionsEv"></span><span id="arrow::compute::Function::default_optionsC"></span><span class="target" id="classarrow_1_1compute_1_1_function_1a19eb16cff543de56016df5883c316e8c"></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="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</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">default_options</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="#_CPPv4NK5arrow7compute8Function15default_optionsEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Returns the default options for this function. </p> |
| <p>Whatever option semantics a <a class="reference internal" href="#classarrow_1_1compute_1_1_function"><span class="std std-ref">Function</span></a> has, implementations must guarantee that <a class="reference internal" href="#classarrow_1_1compute_1_1_function_1a19eb16cff543de56016df5883c316e8c"><span class="std std-ref">default_options()</span></a> is valid to pass to Execute as options. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow7compute8Function7is_pureEv"> |
| <span id="_CPPv3NK5arrow7compute8Function7is_pureEv"></span><span id="_CPPv2NK5arrow7compute8Function7is_pureEv"></span><span id="arrow::compute::Function::is_pureC"></span><span class="target" id="classarrow_1_1compute_1_1_function_1a4a9d7331cb88b741497b875e020f8229"></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">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">is_pure</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="#_CPPv4NK5arrow7compute8Function7is_pureEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Returns the pure property for this function. </p> |
| <p>Impure functions are those that may return different results for the same input arguments. For example, a function that returns a random number is not pure. An expression containing only pure functions can be simplified by pre-evaluating any sub-expressions that have constant arguments. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute14ScalarFunctionE"> |
| <span id="_CPPv3N5arrow7compute14ScalarFunctionE"></span><span id="_CPPv2N5arrow7compute14ScalarFunctionE"></span><span id="arrow::compute::ScalarFunction"></span><span class="target" id="classarrow_1_1compute_1_1_scalar_function"></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">ScalarFunction</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">compute</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">FunctionImpl</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">ScalarKernel</span></span><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute14ScalarFunctionE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/function.h></em></div> |
| <p>A function that executes elementwise operations on arrays or scalars, and therefore whose results generally do not depend on the order of the values in the arguments. </p> |
| <p>Accepts and returns arrays that are all of the same size. These functions roughly correspond to the functions used in SQL expressions. </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="_CPPv4N5arrow7compute14ScalarFunction9AddKernelENSt6vectorI9InputTypeEE10OutputType15ArrayKernelExec10KernelInit"> |
| <span id="_CPPv3N5arrow7compute14ScalarFunction9AddKernelENSt6vectorI9InputTypeEE10OutputType15ArrayKernelExec10KernelInit"></span><span id="_CPPv2N5arrow7compute14ScalarFunction9AddKernelENSt6vectorI9InputTypeEE10OutputType15ArrayKernelExec10KernelInit"></span><span id="arrow::compute::ScalarFunction::AddKernel__std::vector:InputType:.OutputType.ArrayKernelExec.KernelInit"></span><span class="target" id="classarrow_1_1compute_1_1_scalar_function_1a82da5feee50e2abed0358da3172327e1"></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">AddKernel</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="n"><span class="pre">InputType</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">in_types</span></span>, <span class="n"><span class="pre">OutputType</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">out_type</span></span>, <span class="n"><span class="pre">ArrayKernelExec</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">exec</span></span>, <span class="n"><span class="pre">KernelInit</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">init</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="#_CPPv4N5arrow7compute14ScalarFunction9AddKernelENSt6vectorI9InputTypeEE10OutputType15ArrayKernelExec10KernelInit" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Add a kernel with given input/output types, no required state initialization, preallocation for fixed-width types, and default null handling (intersect validity bitmaps of inputs). </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute14ScalarFunction9AddKernelE12ScalarKernel"> |
| <span id="_CPPv3N5arrow7compute14ScalarFunction9AddKernelE12ScalarKernel"></span><span id="_CPPv2N5arrow7compute14ScalarFunction9AddKernelE12ScalarKernel"></span><span id="arrow::compute::ScalarFunction::AddKernel__ScalarKernel"></span><span class="target" id="classarrow_1_1compute_1_1_scalar_function_1aff763f77d3142df9f97c56207c347b0f"></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">AddKernel</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">ScalarKernel</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">kernel</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute14ScalarFunction9AddKernelE12ScalarKernel" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Add a kernel (function implementation). </p> |
| <p>Returns error if the kernel’s signature does not match the function’s arity. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow7compute14ScalarFunction7is_pureEv"> |
| <span id="_CPPv3NK5arrow7compute14ScalarFunction7is_pureEv"></span><span id="_CPPv2NK5arrow7compute14ScalarFunction7is_pureEv"></span><span id="arrow::compute::ScalarFunction::is_pureC"></span><span class="target" id="classarrow_1_1compute_1_1_scalar_function_1a2366fd4c5b482e0d6bd27f89d7bbd16f"></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">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">is_pure</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="#_CPPv4NK5arrow7compute14ScalarFunction7is_pureEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Returns the pure property for this function. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute14VectorFunctionE"> |
| <span id="_CPPv3N5arrow7compute14VectorFunctionE"></span><span id="_CPPv2N5arrow7compute14VectorFunctionE"></span><span id="arrow::compute::VectorFunction"></span><span class="target" id="classarrow_1_1compute_1_1_vector_function"></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">VectorFunction</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">compute</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">FunctionImpl</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">VectorKernel</span></span><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute14VectorFunctionE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/function.h></em></div> |
| <p>A function that executes general array operations that may yield outputs of different sizes or have results that depend on the whole array contents. </p> |
| <p>These functions roughly correspond to the functions found in non-SQL array languages like APL and its derivatives. </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="_CPPv4N5arrow7compute14VectorFunction9AddKernelENSt6vectorI9InputTypeEE10OutputType15ArrayKernelExec10KernelInit"> |
| <span id="_CPPv3N5arrow7compute14VectorFunction9AddKernelENSt6vectorI9InputTypeEE10OutputType15ArrayKernelExec10KernelInit"></span><span id="_CPPv2N5arrow7compute14VectorFunction9AddKernelENSt6vectorI9InputTypeEE10OutputType15ArrayKernelExec10KernelInit"></span><span id="arrow::compute::VectorFunction::AddKernel__std::vector:InputType:.OutputType.ArrayKernelExec.KernelInit"></span><span class="target" id="classarrow_1_1compute_1_1_vector_function_1a3e94d260ee45e9701de81d7c6ef0ed6c"></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">AddKernel</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="n"><span class="pre">InputType</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">in_types</span></span>, <span class="n"><span class="pre">OutputType</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">out_type</span></span>, <span class="n"><span class="pre">ArrayKernelExec</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">exec</span></span>, <span class="n"><span class="pre">KernelInit</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">init</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="#_CPPv4N5arrow7compute14VectorFunction9AddKernelENSt6vectorI9InputTypeEE10OutputType15ArrayKernelExec10KernelInit" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Add a simple kernel with given input/output types, no required state initialization, no data preallocation, and no preallocation of the validity bitmap. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute14VectorFunction9AddKernelE12VectorKernel"> |
| <span id="_CPPv3N5arrow7compute14VectorFunction9AddKernelE12VectorKernel"></span><span id="_CPPv2N5arrow7compute14VectorFunction9AddKernelE12VectorKernel"></span><span id="arrow::compute::VectorFunction::AddKernel__VectorKernel"></span><span class="target" id="classarrow_1_1compute_1_1_vector_function_1aed448699d80407091e952d405de7a603"></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">AddKernel</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">VectorKernel</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">kernel</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute14VectorFunction9AddKernelE12VectorKernel" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Add a kernel (function implementation). </p> |
| <p>Returns error if the kernel’s signature does not match the function’s arity. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute23ScalarAggregateFunctionE"> |
| <span id="_CPPv3N5arrow7compute23ScalarAggregateFunctionE"></span><span id="_CPPv2N5arrow7compute23ScalarAggregateFunctionE"></span><span id="arrow::compute::ScalarAggregateFunction"></span><span class="target" id="classarrow_1_1compute_1_1_scalar_aggregate_function"></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">ScalarAggregateFunction</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">compute</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">FunctionImpl</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">ScalarAggregateKernel</span></span><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute23ScalarAggregateFunctionE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/function.h></em></div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute23ScalarAggregateFunction9AddKernelE21ScalarAggregateKernel"> |
| <span id="_CPPv3N5arrow7compute23ScalarAggregateFunction9AddKernelE21ScalarAggregateKernel"></span><span id="_CPPv2N5arrow7compute23ScalarAggregateFunction9AddKernelE21ScalarAggregateKernel"></span><span id="arrow::compute::ScalarAggregateFunction::AddKernel__ScalarAggregateKernel"></span><span class="target" id="classarrow_1_1compute_1_1_scalar_aggregate_function_1a4b977b9db176b6707fd2abf1056d9164"></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">AddKernel</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">ScalarAggregateKernel</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">kernel</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute23ScalarAggregateFunction9AddKernelE21ScalarAggregateKernel" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Add a kernel (function implementation). </p> |
| <p>Returns error if the kernel’s signature does not match the function’s arity. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute21HashAggregateFunctionE"> |
| <span id="_CPPv3N5arrow7compute21HashAggregateFunctionE"></span><span id="_CPPv2N5arrow7compute21HashAggregateFunctionE"></span><span id="arrow::compute::HashAggregateFunction"></span><span class="target" id="classarrow_1_1compute_1_1_hash_aggregate_function"></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">HashAggregateFunction</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">compute</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">FunctionImpl</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">HashAggregateKernel</span></span><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute21HashAggregateFunctionE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/function.h></em></div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute21HashAggregateFunction9AddKernelE19HashAggregateKernel"> |
| <span id="_CPPv3N5arrow7compute21HashAggregateFunction9AddKernelE19HashAggregateKernel"></span><span id="_CPPv2N5arrow7compute21HashAggregateFunction9AddKernelE19HashAggregateKernel"></span><span id="arrow::compute::HashAggregateFunction::AddKernel__HashAggregateKernel"></span><span class="target" id="classarrow_1_1compute_1_1_hash_aggregate_function_1af972ca295832433d7ed154e37d64d2f5"></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">AddKernel</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">HashAggregateKernel</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">kernel</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute21HashAggregateFunction9AddKernelE19HashAggregateKernel" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Add a kernel (function implementation). </p> |
| <p>Returns error if the kernel’s signature does not match the function’s arity. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute12MetaFunctionE"> |
| <span id="_CPPv3N5arrow7compute12MetaFunctionE"></span><span id="_CPPv2N5arrow7compute12MetaFunctionE"></span><span id="arrow::compute::MetaFunction"></span><span class="target" id="classarrow_1_1compute_1_1_meta_function"></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">MetaFunction</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute8FunctionE" title="arrow::compute::Function"><span class="n"><span class="pre">Function</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute12MetaFunctionE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/function.h></em></div> |
| <p>A function that dispatches to other functions. </p> |
| <p>Must implement MetaFunction::ExecuteImpl.</p> |
| <p>For <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#classarrow_1_1_chunked_array"><span class="std std-ref">ChunkedArray</span></a>, and <a class="reference internal" href="scalar.html#structarrow_1_1_scalar"><span class="std std-ref">Scalar</span></a> <a class="reference internal" href="#structarrow_1_1_datum"><span class="std std-ref">Datum</span></a> kinds, may rely on the execution of concrete <a class="reference internal" href="#classarrow_1_1compute_1_1_function"><span class="std std-ref">Function</span></a> types, but must handle other <a class="reference internal" href="#structarrow_1_1_datum"><span class="std std-ref">Datum</span></a> kinds on its own. </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="_CPPv4NK5arrow7compute12MetaFunction11num_kernelsEv"> |
| <span id="_CPPv3NK5arrow7compute12MetaFunction11num_kernelsEv"></span><span id="_CPPv2NK5arrow7compute12MetaFunction11num_kernelsEv"></span><span id="arrow::compute::MetaFunction::num_kernelsC"></span><span class="target" id="classarrow_1_1compute_1_1_meta_function_1a7bb80ff72426626b44242cdec52ecd79"></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">num_kernels</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="#_CPPv4NK5arrow7compute12MetaFunction11num_kernelsEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Returns the number of registered kernels for this function. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow7compute12MetaFunction7ExecuteERKNSt6vectorI5DatumEEPK15FunctionOptionsP11ExecContext"> |
| <span id="_CPPv3NK5arrow7compute12MetaFunction7ExecuteERKNSt6vectorI5DatumEEPK15FunctionOptionsP11ExecContext"></span><span id="_CPPv2NK5arrow7compute12MetaFunction7ExecuteERKNSt6vectorI5DatumEEPK15FunctionOptionsP11ExecContext"></span><span id="arrow::compute::MetaFunction::Execute__std::vector:Datum:CR.FunctionOptionsCP.ExecContextPC"></span><span class="target" id="classarrow_1_1compute_1_1_meta_function_1a2e181367ce136d468dbd0bd08b0cf2b7"></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><a class="reference internal" href="#_CPPv4N5arrow5DatumE" title="arrow::Datum"><span class="n"><span class="pre">Datum</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">Execute</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="#_CPPv4N5arrow5DatumE" title="arrow::Datum"><span class="n"><span class="pre">Datum</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">args</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="n"><span class="pre">ExecContext</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">ctx</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="#_CPPv4NK5arrow7compute12MetaFunction7ExecuteERKNSt6vectorI5DatumEEPK15FunctionOptionsP11ExecContext" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Execute the function eagerly with the passed input arguments with kernel dispatch, batch iteration, and memory allocation details taken care of. </p> |
| <p>If the <code class="docutils literal notranslate"><span class="pre">options</span></code> pointer is null, then <code class="docutils literal notranslate"><a class="reference internal" href="#classarrow_1_1compute_1_1_function_1a19eb16cff543de56016df5883c316e8c"><span class="std std-ref"><span class="pre">default_options()</span></span></a></code> will be used.</p> |
| <p>This function can be overridden in subclasses. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute19FunctionOptionsTypeE"> |
| <span id="_CPPv3N5arrow7compute19FunctionOptionsTypeE"></span><span id="_CPPv2N5arrow7compute19FunctionOptionsTypeE"></span><span id="arrow::compute::FunctionOptionsType"></span><span class="target" id="classarrow_1_1compute_1_1_function_options_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">FunctionOptionsType</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute19FunctionOptionsTypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/function_options.h></em></div> |
| <p>Extension point for defining options outside libarrow (but still within this project). </p> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute15FunctionOptionsE"> |
| <span id="_CPPv3N5arrow7compute15FunctionOptionsE"></span><span id="_CPPv2N5arrow7compute15FunctionOptionsE"></span><span id="arrow::compute::FunctionOptions"></span><span class="target" id="classarrow_1_1compute_1_1_function_options"></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">FunctionOptions</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="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/function_options.h></em></div> |
| <p>Base class for specifying options configuring a function’s behavior, such as error handling. </p> |
| <p>Subclassed by <a class="reference internal" href="#classarrow_1_1compute_1_1_arithmetic_options"><span class="std std-ref">arrow::compute::ArithmeticOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_array_sort_options"><span class="std std-ref">arrow::compute::ArraySortOptions</span></a>, <a class="reference internal" href="#structarrow_1_1compute_1_1_assume_timezone_options"><span class="std std-ref">arrow::compute::AssumeTimezoneOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_cast_options"><span class="std std-ref">arrow::compute::CastOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_count_options"><span class="std std-ref">arrow::compute::CountOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_cumulative_options"><span class="std std-ref">arrow::compute::CumulativeOptions</span></a>, <a class="reference internal" href="#structarrow_1_1compute_1_1_day_of_week_options"><span class="std std-ref">arrow::compute::DayOfWeekOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_dictionary_encode_options"><span class="std std-ref">arrow::compute::DictionaryEncodeOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_element_wise_aggregate_options"><span class="std std-ref">arrow::compute::ElementWiseAggregateOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_extract_regex_options"><span class="std std-ref">arrow::compute::ExtractRegexOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_filter_options"><span class="std std-ref">arrow::compute::FilterOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_index_options"><span class="std std-ref">arrow::compute::IndexOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_join_options"><span class="std std-ref">arrow::compute::JoinOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_list_flatten_options"><span class="std std-ref">arrow::compute::ListFlattenOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_list_slice_options"><span class="std std-ref">arrow::compute::ListSliceOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_make_struct_options"><span class="std std-ref">arrow::compute::MakeStructOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_map_lookup_options"><span class="std std-ref">arrow::compute::MapLookupOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_match_substring_options"><span class="std std-ref">arrow::compute::MatchSubstringOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_mode_options"><span class="std std-ref">arrow::compute::ModeOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_null_options"><span class="std std-ref">arrow::compute::NullOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_pad_options"><span class="std std-ref">arrow::compute::PadOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_pairwise_options"><span class="std std-ref">arrow::compute::PairwiseOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_partition_nth_options"><span class="std std-ref">arrow::compute::PartitionNthOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_quantile_options"><span class="std std-ref">arrow::compute::QuantileOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_random_options"><span class="std std-ref">arrow::compute::RandomOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_rank_options"><span class="std std-ref">arrow::compute::RankOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_replace_slice_options"><span class="std std-ref">arrow::compute::ReplaceSliceOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_replace_substring_options"><span class="std std-ref">arrow::compute::ReplaceSubstringOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_round_binary_options"><span class="std std-ref">arrow::compute::RoundBinaryOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_round_options"><span class="std std-ref">arrow::compute::RoundOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_round_temporal_options"><span class="std std-ref">arrow::compute::RoundTemporalOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_round_to_multiple_options"><span class="std std-ref">arrow::compute::RoundToMultipleOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_run_end_encode_options"><span class="std std-ref">arrow::compute::RunEndEncodeOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_scalar_aggregate_options"><span class="std std-ref">arrow::compute::ScalarAggregateOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_select_k_options"><span class="std std-ref">arrow::compute::SelectKOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_set_lookup_options"><span class="std std-ref">arrow::compute::SetLookupOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_slice_options"><span class="std std-ref">arrow::compute::SliceOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_sort_options"><span class="std std-ref">arrow::compute::SortOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_split_options"><span class="std std-ref">arrow::compute::SplitOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_split_pattern_options"><span class="std std-ref">arrow::compute::SplitPatternOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_strftime_options"><span class="std std-ref">arrow::compute::StrftimeOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_strptime_options"><span class="std std-ref">arrow::compute::StrptimeOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_struct_field_options"><span class="std std-ref">arrow::compute::StructFieldOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_t_digest_options"><span class="std std-ref">arrow::compute::TDigestOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_take_options"><span class="std std-ref">arrow::compute::TakeOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_trim_options"><span class="std std-ref">arrow::compute::TrimOptions</span></a>, <a class="reference internal" href="#structarrow_1_1compute_1_1_utf8_normalize_options"><span class="std std-ref">arrow::compute::Utf8NormalizeOptions</span></a>, <a class="reference internal" href="#classarrow_1_1compute_1_1_variance_options"><span class="std std-ref">arrow::compute::VarianceOptions</span></a>, <a class="reference internal" href="#structarrow_1_1compute_1_1_week_options"><span class="std std-ref">arrow::compute::WeekOptions</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="_CPPv4NK5arrow7compute15FunctionOptions9SerializeEv"> |
| <span id="_CPPv3NK5arrow7compute15FunctionOptions9SerializeEv"></span><span id="_CPPv2NK5arrow7compute15FunctionOptions9SerializeEv"></span><span id="arrow::compute::FunctionOptions::SerializeC"></span><span class="target" id="classarrow_1_1compute_1_1_function_options_1a72076832b00a9a42c9e634e23b154ffa"></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="memory.html#_CPPv4N5arrow6BufferE" title="arrow::Buffer"><span class="n"><span class="pre">Buffer</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">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><a class="headerlink" href="#_CPPv4NK5arrow7compute15FunctionOptions9SerializeEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Serialize an options struct to a buffer. </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="_CPPv4N5arrow7compute15FunctionOptions11DeserializeERKNSt6stringERK6Buffer"> |
| <span id="_CPPv3N5arrow7compute15FunctionOptions11DeserializeERKNSt6stringERK6Buffer"></span><span id="_CPPv2N5arrow7compute15FunctionOptions11DeserializeERKNSt6stringERK6Buffer"></span><span id="arrow::compute::FunctionOptions::Deserialize__ssCR.BufferCR"></span><span class="target" id="classarrow_1_1compute_1_1_function_options_1a5419e69f688b4601cf8599add35561f5"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</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="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">type_name</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="memory.html#_CPPv4N5arrow6BufferE" title="arrow::Buffer"><span class="n"><span class="pre">Buffer</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">buffer</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute15FunctionOptions11DeserializeERKNSt6stringERK6Buffer" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Deserialize an options struct from a buffer. </p> |
| <p>Note: this will only look for <code class="docutils literal notranslate"><span class="pre">type_name</span></code> in the default <a class="reference internal" href="#classarrow_1_1compute_1_1_function_registry"><span class="std std-ref">FunctionRegistry</span></a>; to use a custom <a class="reference internal" href="#classarrow_1_1compute_1_1_function_registry"><span class="std std-ref">FunctionRegistry</span></a>, look up the <a class="reference internal" href="#classarrow_1_1compute_1_1_function_options_type"><span class="std std-ref">FunctionOptionsType</span></a>, then call FunctionOptionsType::Deserialize(). </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| </section> |
| <section id="function-execution"> |
| <h2>Function execution<a class="headerlink" href="#function-execution" title="Permalink to this heading">#</a></h2> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv419GetFunctionExecutorRKNSt6stringENSt6vectorI10TypeHolderEEPK15FunctionOptionsP16FunctionRegistry"> |
| <span id="_CPPv319GetFunctionExecutorRKNSt6stringENSt6vectorI10TypeHolderEEPK15FunctionOptionsP16FunctionRegistry"></span><span id="_CPPv219GetFunctionExecutorRKNSt6stringENSt6vectorI10TypeHolderEEPK15FunctionOptionsP16FunctionRegistry"></span><span id="GetFunctionExecutor__ssCR.std::vector:TypeHolder:.FunctionOptionsCP.FunctionRegistryP"></span><span class="target" id="group__compute-function-executor_1ga8419830db84121b2b3d3b64b1e9bdc08"></span><span class="n"><span class="pre">Result</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">FunctionExecutor</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">GetFunctionExecutor</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">func_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">vector</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">TypeHolder</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">in_types</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">FunctionOptions</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></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><span class="n"><span class="pre">NULLPTR</span></span>, <span class="n"><span class="pre">FunctionRegistry</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">func_registry</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="#_CPPv419GetFunctionExecutorRKNSt6stringENSt6vectorI10TypeHolderEEPK15FunctionOptionsP16FunctionRegistry" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>One-shot executor provider for all types of functions. </p> |
| <p>This function creates and initializes a <code class="docutils literal notranslate"><a class="reference internal" href="#classarrow_1_1compute_1_1_function_executor"><span class="std std-ref"><span class="pre">FunctionExecutor</span></span></a></code> appropriate for the given function name, input types and function options. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv419GetFunctionExecutorRKNSt6stringERKNSt6vectorI5DatumEEPK15FunctionOptionsP16FunctionRegistry"> |
| <span id="_CPPv319GetFunctionExecutorRKNSt6stringERKNSt6vectorI5DatumEEPK15FunctionOptionsP16FunctionRegistry"></span><span id="_CPPv219GetFunctionExecutorRKNSt6stringERKNSt6vectorI5DatumEEPK15FunctionOptionsP16FunctionRegistry"></span><span id="GetFunctionExecutor__ssCR.std::vector:Datum:CR.FunctionOptionsCP.FunctionRegistryP"></span><span class="target" id="group__compute-function-executor_1ga7a693a9ae1cd53e2d7d5297626ac1da5"></span><span class="n"><span class="pre">Result</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">FunctionExecutor</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">GetFunctionExecutor</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">func_name</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">Datum</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">args</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">FunctionOptions</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></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><span class="n"><span class="pre">NULLPTR</span></span>, <span class="n"><span class="pre">FunctionRegistry</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">func_registry</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="#_CPPv419GetFunctionExecutorRKNSt6stringERKNSt6vectorI5DatumEEPK15FunctionOptionsP16FunctionRegistry" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>One-shot executor provider for all types of functions. </p> |
| <p>This function creates and initializes a <code class="docutils literal notranslate"><a class="reference internal" href="#classarrow_1_1compute_1_1_function_executor"><span class="std std-ref"><span class="pre">FunctionExecutor</span></span></a></code> appropriate for the given function name, input types (taken from the <a class="reference internal" href="#structarrow_1_1_datum"><span class="std std-ref">Datum</span></a> arguments) and function options. </p> |
| </dd></dl> |
| |
| </section> |
| <section id="function-registry"> |
| <h2>Function registry<a class="headerlink" href="#function-registry" title="Permalink to this heading">#</a></h2> |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16FunctionRegistryE"> |
| <span id="_CPPv3N5arrow7compute16FunctionRegistryE"></span><span id="_CPPv2N5arrow7compute16FunctionRegistryE"></span><span id="arrow::compute::FunctionRegistry"></span><span class="target" id="classarrow_1_1compute_1_1_function_registry"></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">FunctionRegistry</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute16FunctionRegistryE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A mutable central function registry for built-in functions as well as user-defined functions. </p> |
| <p>Functions are implementations of <a class="reference internal" href="#classarrow_1_1compute_1_1_function"><span class="std std-ref">arrow::compute::Function</span></a>.</p> |
| <p>Generally, each function contains kernels which are implementations of a function for a specific argument signature. After looking up a function in the registry, one can either execute it eagerly with <a class="reference internal" href="#classarrow_1_1compute_1_1_function_1ae8bf178b183e307edefadb2614fa53da"><span class="std std-ref">Function::Execute</span></a> or use one of the function’s dispatch methods to pick a suitable kernel for lower-level function execution. </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="_CPPv4N5arrow7compute16FunctionRegistry14CanAddFunctionENSt10shared_ptrI8FunctionEEb"> |
| <span id="_CPPv3N5arrow7compute16FunctionRegistry14CanAddFunctionENSt10shared_ptrI8FunctionEEb"></span><span id="_CPPv2N5arrow7compute16FunctionRegistry14CanAddFunctionENSt10shared_ptrI8FunctionEEb"></span><span id="arrow::compute::FunctionRegistry::CanAddFunction__std::shared_ptr:Function:.b"></span><span class="target" id="classarrow_1_1compute_1_1_function_registry_1a0d7fe2792cfeb6c160eb67759bb1b024"></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">CanAddFunction</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="#_CPPv4N5arrow7compute8FunctionE" title="arrow::compute::Function"><span class="n"><span class="pre">Function</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">function</span></span>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">allow_overwrite</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="#_CPPv4N5arrow7compute16FunctionRegistry14CanAddFunctionENSt10shared_ptrI8FunctionEEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Check whether a new function can be added to the registry. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><a class="reference internal" href="support.html#classarrow_1_1_status_1a9cb12a31b919deae25d1089da1cf21c7"><span class="std std-ref">Status::KeyError</span></a> if a function with the same name is already registered. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16FunctionRegistry11AddFunctionENSt10shared_ptrI8FunctionEEb"> |
| <span id="_CPPv3N5arrow7compute16FunctionRegistry11AddFunctionENSt10shared_ptrI8FunctionEEb"></span><span id="_CPPv2N5arrow7compute16FunctionRegistry11AddFunctionENSt10shared_ptrI8FunctionEEb"></span><span id="arrow::compute::FunctionRegistry::AddFunction__std::shared_ptr:Function:.b"></span><span class="target" id="classarrow_1_1compute_1_1_function_registry_1a14aa33224ad712b38264785e78030e89"></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">AddFunction</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="#_CPPv4N5arrow7compute8FunctionE" title="arrow::compute::Function"><span class="n"><span class="pre">Function</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">function</span></span>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">allow_overwrite</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="#_CPPv4N5arrow7compute16FunctionRegistry11AddFunctionENSt10shared_ptrI8FunctionEEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Add a new function to the registry. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><a class="reference internal" href="support.html#classarrow_1_1_status_1a9cb12a31b919deae25d1089da1cf21c7"><span class="std std-ref">Status::KeyError</span></a> if a function with the same name is already registered. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16FunctionRegistry11CanAddAliasERKNSt6stringERKNSt6stringE"> |
| <span id="_CPPv3N5arrow7compute16FunctionRegistry11CanAddAliasERKNSt6stringERKNSt6stringE"></span><span id="_CPPv2N5arrow7compute16FunctionRegistry11CanAddAliasERKNSt6stringERKNSt6stringE"></span><span id="arrow::compute::FunctionRegistry::CanAddAlias__ssCR.ssCR"></span><span class="target" id="classarrow_1_1compute_1_1_function_registry_1af51a9518c6cd9cf206d8f30c8d343969"></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">CanAddAlias</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">target_name</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">source_name</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute16FunctionRegistry11CanAddAliasERKNSt6stringERKNSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Check whether an alias can be added for the given function name. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><a class="reference internal" href="support.html#classarrow_1_1_status_1a9cb12a31b919deae25d1089da1cf21c7"><span class="std std-ref">Status::KeyError</span></a> if the function with the given name is not registered. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16FunctionRegistry8AddAliasERKNSt6stringERKNSt6stringE"> |
| <span id="_CPPv3N5arrow7compute16FunctionRegistry8AddAliasERKNSt6stringERKNSt6stringE"></span><span id="_CPPv2N5arrow7compute16FunctionRegistry8AddAliasERKNSt6stringERKNSt6stringE"></span><span id="arrow::compute::FunctionRegistry::AddAlias__ssCR.ssCR"></span><span class="target" id="classarrow_1_1compute_1_1_function_registry_1a118660594caa1e15d7a949858bfc26be"></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">AddAlias</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">target_name</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">source_name</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute16FunctionRegistry8AddAliasERKNSt6stringERKNSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Add alias for the given function name. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><a class="reference internal" href="support.html#classarrow_1_1_status_1a9cb12a31b919deae25d1089da1cf21c7"><span class="std std-ref">Status::KeyError</span></a> if the function with the given name is not registered. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16FunctionRegistry25CanAddFunctionOptionsTypeEPK19FunctionOptionsTypeb"> |
| <span id="_CPPv3N5arrow7compute16FunctionRegistry25CanAddFunctionOptionsTypeEPK19FunctionOptionsTypeb"></span><span id="_CPPv2N5arrow7compute16FunctionRegistry25CanAddFunctionOptionsTypeEPK19FunctionOptionsTypeb"></span><span id="arrow::compute::FunctionRegistry::CanAddFunctionOptionsType__FunctionOptionsTypeCP.b"></span><span class="target" id="classarrow_1_1compute_1_1_function_registry_1abaabe733e5e5613e9597806b92eb4d9b"></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">CanAddFunctionOptionsType</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="#_CPPv4N5arrow7compute19FunctionOptionsTypeE" title="arrow::compute::FunctionOptionsType"><span class="n"><span class="pre">FunctionOptionsType</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">options_type</span></span>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">allow_overwrite</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="#_CPPv4N5arrow7compute16FunctionRegistry25CanAddFunctionOptionsTypeEPK19FunctionOptionsTypeb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Check whether a new function options type can be added to the registry. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><a class="reference internal" href="support.html#classarrow_1_1_status_1a9cb12a31b919deae25d1089da1cf21c7"><span class="std std-ref">Status::KeyError</span></a> if a function options type with the same name is already registered. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16FunctionRegistry22AddFunctionOptionsTypeEPK19FunctionOptionsTypeb"> |
| <span id="_CPPv3N5arrow7compute16FunctionRegistry22AddFunctionOptionsTypeEPK19FunctionOptionsTypeb"></span><span id="_CPPv2N5arrow7compute16FunctionRegistry22AddFunctionOptionsTypeEPK19FunctionOptionsTypeb"></span><span id="arrow::compute::FunctionRegistry::AddFunctionOptionsType__FunctionOptionsTypeCP.b"></span><span class="target" id="classarrow_1_1compute_1_1_function_registry_1af27c600d62c8bfae51d9c666be205e39"></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">AddFunctionOptionsType</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="#_CPPv4N5arrow7compute19FunctionOptionsTypeE" title="arrow::compute::FunctionOptionsType"><span class="n"><span class="pre">FunctionOptionsType</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">options_type</span></span>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">allow_overwrite</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="#_CPPv4N5arrow7compute16FunctionRegistry22AddFunctionOptionsTypeEPK19FunctionOptionsTypeb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Add a new function options type to the registry. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><a class="reference internal" href="support.html#classarrow_1_1_status_1a9cb12a31b919deae25d1089da1cf21c7"><span class="std std-ref">Status::KeyError</span></a> if a function options type with the same name is already registered. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow7compute16FunctionRegistry11GetFunctionERKNSt6stringE"> |
| <span id="_CPPv3NK5arrow7compute16FunctionRegistry11GetFunctionERKNSt6stringE"></span><span id="_CPPv2NK5arrow7compute16FunctionRegistry11GetFunctionERKNSt6stringE"></span><span id="arrow::compute::FunctionRegistry::GetFunction__ssCRC"></span><span class="target" id="classarrow_1_1compute_1_1_function_registry_1a20be3d30814abb4f284f5f08a18b4241"></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="#_CPPv4N5arrow7compute8FunctionE" title="arrow::compute::Function"><span class="n"><span class="pre">Function</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">GetFunction</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="#_CPPv4NK5arrow7compute16FunctionRegistry11GetFunctionERKNSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieve a function by name from the registry. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow7compute16FunctionRegistry16GetFunctionNamesEv"> |
| <span id="_CPPv3NK5arrow7compute16FunctionRegistry16GetFunctionNamesEv"></span><span id="_CPPv2NK5arrow7compute16FunctionRegistry16GetFunctionNamesEv"></span><span id="arrow::compute::FunctionRegistry::GetFunctionNamesC"></span><span class="target" id="classarrow_1_1compute_1_1_function_registry_1ae93cfb28fc42c082588c69fb0b63cb00"></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="sig-name descname"><span class="n"><span class="pre">GetFunctionNames</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="#_CPPv4NK5arrow7compute16FunctionRegistry16GetFunctionNamesEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return vector of all entry names in the registry. </p> |
| <p>Helpful for displaying a manifest of available functions. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow7compute16FunctionRegistry22GetFunctionOptionsTypeERKNSt6stringE"> |
| <span id="_CPPv3NK5arrow7compute16FunctionRegistry22GetFunctionOptionsTypeERKNSt6stringE"></span><span id="_CPPv2NK5arrow7compute16FunctionRegistry22GetFunctionOptionsTypeERKNSt6stringE"></span><span id="arrow::compute::FunctionRegistry::GetFunctionOptionsType__ssCRC"></span><span class="target" id="classarrow_1_1compute_1_1_function_registry_1ab51acf8efb868096732a18f905df5de5"></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="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow7compute19FunctionOptionsTypeE" title="arrow::compute::FunctionOptionsType"><span class="n"><span class="pre">FunctionOptionsType</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">GetFunctionOptionsType</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="#_CPPv4NK5arrow7compute16FunctionRegistry22GetFunctionOptionsTypeERKNSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieve a function options type by name from the registry. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow7compute16FunctionRegistry13num_functionsEv"> |
| <span id="_CPPv3NK5arrow7compute16FunctionRegistry13num_functionsEv"></span><span id="_CPPv2NK5arrow7compute16FunctionRegistry13num_functionsEv"></span><span id="arrow::compute::FunctionRegistry::num_functionsC"></span><span class="target" id="classarrow_1_1compute_1_1_function_registry_1ad66f2392a81a4ec24be8ea93fc5dd645"></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_functions</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="#_CPPv4NK5arrow7compute16FunctionRegistry13num_functionsEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The number of currently registered functions. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow7compute16FunctionRegistry13cast_functionEv"> |
| <span id="_CPPv3NK5arrow7compute16FunctionRegistry13cast_functionEv"></span><span id="_CPPv2NK5arrow7compute16FunctionRegistry13cast_functionEv"></span><span id="arrow::compute::FunctionRegistry::cast_functionC"></span><span class="target" id="classarrow_1_1compute_1_1_function_registry_1a357773e7bcb0997a371324da01e69a04"></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow7compute8FunctionE" title="arrow::compute::Function"><span class="n"><span class="pre">Function</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">cast_function</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="#_CPPv4NK5arrow7compute16FunctionRegistry13cast_functionEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The cast function object registered in AddFunction. </p> |
| <p>Helpful for get cast function as needed. </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="_CPPv4N5arrow7compute16FunctionRegistry4MakeEv"> |
| <span id="_CPPv3N5arrow7compute16FunctionRegistry4MakeEv"></span><span id="_CPPv2N5arrow7compute16FunctionRegistry4MakeEv"></span><span id="arrow::compute::FunctionRegistry::Make"></span><span class="target" id="classarrow_1_1compute_1_1_function_registry_1a05a70f1de3c1178d7283102119cd0f52"></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">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute16FunctionRegistryE" title="arrow::compute::FunctionRegistry"><span class="n"><span class="pre">FunctionRegistry</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">Make</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute16FunctionRegistry4MakeEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Construct a new registry. </p> |
| <p>Most users only need to use the global registry. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16FunctionRegistry4MakeEP16FunctionRegistry"> |
| <span id="_CPPv3N5arrow7compute16FunctionRegistry4MakeEP16FunctionRegistry"></span><span id="_CPPv2N5arrow7compute16FunctionRegistry4MakeEP16FunctionRegistry"></span><span id="arrow::compute::FunctionRegistry::Make__FunctionRegistryP"></span><span class="target" id="classarrow_1_1compute_1_1_function_registry_1a4e0e0a3e26a496024c66ed4db61d66d2"></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">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute16FunctionRegistryE" title="arrow::compute::FunctionRegistry"><span class="n"><span class="pre">FunctionRegistry</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">Make</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4N5arrow7compute16FunctionRegistryE" title="arrow::compute::FunctionRegistry"><span class="n"><span class="pre">FunctionRegistry</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">parent</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute16FunctionRegistry4MakeEP16FunctionRegistry" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Construct a new nested registry with the given parent. </p> |
| <p>Most users only need to use the global registry. The returned registry never changes its parent, even when an operation allows overwriting. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute19GetFunctionRegistryEv"> |
| <span id="_CPPv3N5arrow7compute19GetFunctionRegistryEv"></span><span id="_CPPv2N5arrow7compute19GetFunctionRegistryEv"></span><span id="arrow::compute::GetFunctionRegistry"></span><span class="target" id="namespacearrow_1_1compute_1aeb3caa10aa4533f49da0efdee2b0ef33"></span><a class="reference internal" href="#_CPPv4N5arrow7compute16FunctionRegistryE" title="arrow::compute::FunctionRegistry"><span class="n"><span class="pre">FunctionRegistry</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></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">compute</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">GetFunctionRegistry</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute19GetFunctionRegistryEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the process-global function registry. </p> |
| </dd></dl> |
| |
| </section> |
| <section id="convenience-functions"> |
| <h2>Convenience functions<a class="headerlink" href="#convenience-functions" title="Permalink to this heading">#</a></h2> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv412CallFunctionRKNSt6stringERKNSt6vectorI5DatumEEPK15FunctionOptionsP11ExecContext"> |
| <span id="_CPPv312CallFunctionRKNSt6stringERKNSt6vectorI5DatumEEPK15FunctionOptionsP11ExecContext"></span><span id="_CPPv212CallFunctionRKNSt6stringERKNSt6vectorI5DatumEEPK15FunctionOptionsP11ExecContext"></span><span id="CallFunction__ssCR.std::vector:Datum:CR.FunctionOptionsCP.ExecContextP"></span><span class="target" id="group__compute-call-function_1ga42f1ab524a68e14253e1f5596fc6c06e"></span><span class="n"><span class="pre">Result</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">Datum</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">CallFunction</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">func_name</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">Datum</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">args</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">FunctionOptions</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="n"><span class="pre">ExecContext</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">ctx</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="#_CPPv412CallFunctionRKNSt6stringERKNSt6vectorI5DatumEEPK15FunctionOptionsP11ExecContext" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>One-shot invoker for all types of functions. </p> |
| <p>Does kernel dispatch, argument checking, iteration of <a class="reference internal" href="array.html#classarrow_1_1_chunked_array"><span class="std std-ref">ChunkedArray</span></a> inputs, and wrapping of outputs. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv412CallFunctionRKNSt6stringERKNSt6vectorI5DatumEEP11ExecContext"> |
| <span id="_CPPv312CallFunctionRKNSt6stringERKNSt6vectorI5DatumEEP11ExecContext"></span><span id="_CPPv212CallFunctionRKNSt6stringERKNSt6vectorI5DatumEEP11ExecContext"></span><span id="CallFunction__ssCR.std::vector:Datum:CR.ExecContextP"></span><span class="target" id="group__compute-call-function_1ga915d0e8ab42b09b90c84989d99f64e2b"></span><span class="n"><span class="pre">Result</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">Datum</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">CallFunction</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">func_name</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">Datum</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">args</span></span>, <span class="n"><span class="pre">ExecContext</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">ctx</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="#_CPPv412CallFunctionRKNSt6stringERKNSt6vectorI5DatumEEP11ExecContext" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Variant of CallFunction which uses a function’s default options. </p> |
| <p>NB: Some functions require <a class="reference internal" href="#classarrow_1_1compute_1_1_function_options"><span class="std std-ref">FunctionOptions</span></a> be provided. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv412CallFunctionRKNSt6stringERK9ExecBatchPK15FunctionOptionsP11ExecContext"> |
| <span id="_CPPv312CallFunctionRKNSt6stringERK9ExecBatchPK15FunctionOptionsP11ExecContext"></span><span id="_CPPv212CallFunctionRKNSt6stringERK9ExecBatchPK15FunctionOptionsP11ExecContext"></span><span id="CallFunction__ssCR.ExecBatchCR.FunctionOptionsCP.ExecContextP"></span><span class="target" id="group__compute-call-function_1ga097efca55ff074c16883066c44733c7a"></span><span class="n"><span class="pre">Result</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">Datum</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">CallFunction</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">func_name</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">ExecBatch</span></span><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="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">FunctionOptions</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="n"><span class="pre">ExecContext</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">ctx</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="#_CPPv412CallFunctionRKNSt6stringERK9ExecBatchPK15FunctionOptionsP11ExecContext" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>One-shot invoker for all types of functions. </p> |
| <p>Does kernel dispatch, argument checking, iteration of <a class="reference internal" href="array.html#classarrow_1_1_chunked_array"><span class="std std-ref">ChunkedArray</span></a> inputs, and wrapping of outputs. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv412CallFunctionRKNSt6stringERK9ExecBatchP11ExecContext"> |
| <span id="_CPPv312CallFunctionRKNSt6stringERK9ExecBatchP11ExecContext"></span><span id="_CPPv212CallFunctionRKNSt6stringERK9ExecBatchP11ExecContext"></span><span id="CallFunction__ssCR.ExecBatchCR.ExecContextP"></span><span class="target" id="group__compute-call-function_1ga0e61b0ed9a29407770584b1d7d31498a"></span><span class="n"><span class="pre">Result</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">Datum</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">CallFunction</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">func_name</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">ExecBatch</span></span><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="n"><span class="pre">ExecContext</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">ctx</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="#_CPPv412CallFunctionRKNSt6stringERK9ExecBatchP11ExecContext" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Variant of CallFunction which uses a function’s default options. </p> |
| <p>NB: Some functions require <a class="reference internal" href="#classarrow_1_1compute_1_1_function_options"><span class="std std-ref">FunctionOptions</span></a> be provided. </p> |
| </dd></dl> |
| |
| </section> |
| <section id="concrete-options-classes"> |
| <h2>Concrete options classes<a class="headerlink" href="#concrete-options-classes" title="Permalink to this heading">#</a></h2> |
| <dl class="cpp enum-class"> |
| <dt class="sig sig-object cpp" id="_CPPv49RoundMode"> |
| <span id="_CPPv39RoundMode"></span><span id="_CPPv29RoundMode"></span><span class="target" id="group__compute-concrete-options_1gaa2da346c4bcd23c4027498376a17f8bb"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </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">RoundMode</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int8_t</span></span><a class="headerlink" href="#_CPPv49RoundMode" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Rounding and tie-breaking modes for round compute functions. </p> |
| <p>Additional details and examples are provided in compute.rst. </p> |
| <p><em>Values:</em></p> |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N9RoundMode4DOWNE"> |
| <span id="_CPPv3N9RoundMode4DOWNE"></span><span id="_CPPv2N9RoundMode4DOWNE"></span><span class="target" id="group__compute-concrete-options_1ggaa2da346c4bcd23c4027498376a17f8bbac4e0e4e3118472beeb2ae75827450f1f"></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">DOWN</span></span></span><a class="headerlink" href="#_CPPv4N9RoundMode4DOWNE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Round to nearest integer less than or equal in magnitude (aka “floor”) </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N9RoundMode2UPE"> |
| <span id="_CPPv3N9RoundMode2UPE"></span><span id="_CPPv2N9RoundMode2UPE"></span><span class="target" id="group__compute-concrete-options_1ggaa2da346c4bcd23c4027498376a17f8bbafbaedde498cdead4f2780217646e9ba1"></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">UP</span></span></span><a class="headerlink" href="#_CPPv4N9RoundMode2UPE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Round to nearest integer greater than or equal in magnitude (aka “ceil”) </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N9RoundMode12TOWARDS_ZEROE"> |
| <span id="_CPPv3N9RoundMode12TOWARDS_ZEROE"></span><span id="_CPPv2N9RoundMode12TOWARDS_ZEROE"></span><span class="target" id="group__compute-concrete-options_1ggaa2da346c4bcd23c4027498376a17f8bba1d7920a65fc4ddd7c0d9c79f250cfab9"></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">TOWARDS_ZERO</span></span></span><a class="headerlink" href="#_CPPv4N9RoundMode12TOWARDS_ZEROE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the integral part without fractional digits (aka “trunc”) </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N9RoundMode16TOWARDS_INFINITYE"> |
| <span id="_CPPv3N9RoundMode16TOWARDS_INFINITYE"></span><span id="_CPPv2N9RoundMode16TOWARDS_INFINITYE"></span><span class="target" id="group__compute-concrete-options_1ggaa2da346c4bcd23c4027498376a17f8bba9691a6c69d8d21912f9a40c57dc9f5dd"></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">TOWARDS_INFINITY</span></span></span><a class="headerlink" href="#_CPPv4N9RoundMode16TOWARDS_INFINITYE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Round negative values with DOWN rule and positive values with UP rule (aka “away from zero”) </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N9RoundMode9HALF_DOWNE"> |
| <span id="_CPPv3N9RoundMode9HALF_DOWNE"></span><span id="_CPPv2N9RoundMode9HALF_DOWNE"></span><span class="target" id="group__compute-concrete-options_1ggaa2da346c4bcd23c4027498376a17f8bba8f7b877b609236c678a778dd131ebcb6"></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_DOWN</span></span></span><a class="headerlink" href="#_CPPv4N9RoundMode9HALF_DOWNE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Round ties with DOWN rule (also called “round half towards negative infinity”) </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N9RoundMode7HALF_UPE"> |
| <span id="_CPPv3N9RoundMode7HALF_UPE"></span><span id="_CPPv2N9RoundMode7HALF_UPE"></span><span class="target" id="group__compute-concrete-options_1ggaa2da346c4bcd23c4027498376a17f8bbae184ac539927e7effd9eae762e9f1904"></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_UP</span></span></span><a class="headerlink" href="#_CPPv4N9RoundMode7HALF_UPE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Round ties with UP rule (also called “round half towards positive infinity”) </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N9RoundMode17HALF_TOWARDS_ZEROE"> |
| <span id="_CPPv3N9RoundMode17HALF_TOWARDS_ZEROE"></span><span id="_CPPv2N9RoundMode17HALF_TOWARDS_ZEROE"></span><span class="target" id="group__compute-concrete-options_1ggaa2da346c4bcd23c4027498376a17f8bba848f88cc76c351854e56b1ac981c8088"></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_TOWARDS_ZERO</span></span></span><a class="headerlink" href="#_CPPv4N9RoundMode17HALF_TOWARDS_ZEROE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Round ties with TOWARDS_ZERO rule (also called “round half away from infinity”) </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N9RoundMode21HALF_TOWARDS_INFINITYE"> |
| <span id="_CPPv3N9RoundMode21HALF_TOWARDS_INFINITYE"></span><span id="_CPPv2N9RoundMode21HALF_TOWARDS_INFINITYE"></span><span class="target" id="group__compute-concrete-options_1ggaa2da346c4bcd23c4027498376a17f8bbaa581a3644994e294bb46771d83da1ace"></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_TOWARDS_INFINITY</span></span></span><a class="headerlink" href="#_CPPv4N9RoundMode21HALF_TOWARDS_INFINITYE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Round ties with TOWARDS_INFINITY rule (also called “round half away from zero”) </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N9RoundMode12HALF_TO_EVENE"> |
| <span id="_CPPv3N9RoundMode12HALF_TO_EVENE"></span><span id="_CPPv2N9RoundMode12HALF_TO_EVENE"></span><span class="target" id="group__compute-concrete-options_1ggaa2da346c4bcd23c4027498376a17f8bba9b77daea70d980d23cca79dc2e1eec48"></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_TO_EVEN</span></span></span><a class="headerlink" href="#_CPPv4N9RoundMode12HALF_TO_EVENE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Round ties to nearest even integer. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N9RoundMode11HALF_TO_ODDE"> |
| <span id="_CPPv3N9RoundMode11HALF_TO_ODDE"></span><span id="_CPPv2N9RoundMode11HALF_TO_ODDE"></span><span class="target" id="group__compute-concrete-options_1ggaa2da346c4bcd23c4027498376a17f8bba50bd72e55c4fedb09479af068597b2fd"></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_TO_ODD</span></span></span><a class="headerlink" href="#_CPPv4N9RoundMode11HALF_TO_ODDE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Round ties to nearest odd integer. </p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="cpp enum-class"> |
| <dt class="sig sig-object cpp" id="_CPPv412CalendarUnit"> |
| <span id="_CPPv312CalendarUnit"></span><span id="_CPPv212CalendarUnit"></span><span class="target" id="group__compute-concrete-options_1ga58de81e235e838dc7c81613cb99e6070"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </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">CalendarUnit</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int8_t</span></span><a class="headerlink" href="#_CPPv412CalendarUnit" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p><em>Values:</em></p> |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N12CalendarUnit10NANOSECONDE"> |
| <span id="_CPPv3N12CalendarUnit10NANOSECONDE"></span><span id="_CPPv2N12CalendarUnit10NANOSECONDE"></span><span class="target" id="group__compute-concrete-options_1gga58de81e235e838dc7c81613cb99e6070aeb8c6d69310ffef899148b680e672652"></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">NANOSECOND</span></span></span><a class="headerlink" href="#_CPPv4N12CalendarUnit10NANOSECONDE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N12CalendarUnit11MICROSECONDE"> |
| <span id="_CPPv3N12CalendarUnit11MICROSECONDE"></span><span id="_CPPv2N12CalendarUnit11MICROSECONDE"></span><span class="target" id="group__compute-concrete-options_1gga58de81e235e838dc7c81613cb99e6070a52a3ae8e5d772e28d4e2105fefd2eed1"></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">MICROSECOND</span></span></span><a class="headerlink" href="#_CPPv4N12CalendarUnit11MICROSECONDE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N12CalendarUnit11MILLISECONDE"> |
| <span id="_CPPv3N12CalendarUnit11MILLISECONDE"></span><span id="_CPPv2N12CalendarUnit11MILLISECONDE"></span><span class="target" id="group__compute-concrete-options_1gga58de81e235e838dc7c81613cb99e6070a241d7907de05ad50c011812e927cd671"></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">MILLISECOND</span></span></span><a class="headerlink" href="#_CPPv4N12CalendarUnit11MILLISECONDE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N12CalendarUnit6SECONDE"> |
| <span id="_CPPv3N12CalendarUnit6SECONDE"></span><span id="_CPPv2N12CalendarUnit6SECONDE"></span><span class="target" id="group__compute-concrete-options_1gga58de81e235e838dc7c81613cb99e6070a2200becb80f0019c4a2ccecec350d0db"></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="#_CPPv4N12CalendarUnit6SECONDE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N12CalendarUnit6MINUTEE"> |
| <span id="_CPPv3N12CalendarUnit6MINUTEE"></span><span id="_CPPv2N12CalendarUnit6MINUTEE"></span><span class="target" id="group__compute-concrete-options_1gga58de81e235e838dc7c81613cb99e6070a46bda4cde2f10bdb9e51e3bbefa4a2bf"></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">MINUTE</span></span></span><a class="headerlink" href="#_CPPv4N12CalendarUnit6MINUTEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N12CalendarUnit4HOURE"> |
| <span id="_CPPv3N12CalendarUnit4HOURE"></span><span id="_CPPv2N12CalendarUnit4HOURE"></span><span class="target" id="group__compute-concrete-options_1gga58de81e235e838dc7c81613cb99e6070add3f965174e8bb2f64523981626ced1a"></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">HOUR</span></span></span><a class="headerlink" href="#_CPPv4N12CalendarUnit4HOURE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N12CalendarUnit3DAYE"> |
| <span id="_CPPv3N12CalendarUnit3DAYE"></span><span id="_CPPv2N12CalendarUnit3DAYE"></span><span class="target" id="group__compute-concrete-options_1gga58de81e235e838dc7c81613cb99e6070a5b1d59b5451c06afb65ab1bc2713cfb4"></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">DAY</span></span></span><a class="headerlink" href="#_CPPv4N12CalendarUnit3DAYE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N12CalendarUnit4WEEKE"> |
| <span id="_CPPv3N12CalendarUnit4WEEKE"></span><span id="_CPPv2N12CalendarUnit4WEEKE"></span><span class="target" id="group__compute-concrete-options_1gga58de81e235e838dc7c81613cb99e6070a02854858ab6190b2e40f3d9b1ee16982"></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">WEEK</span></span></span><a class="headerlink" href="#_CPPv4N12CalendarUnit4WEEKE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N12CalendarUnit5MONTHE"> |
| <span id="_CPPv3N12CalendarUnit5MONTHE"></span><span id="_CPPv2N12CalendarUnit5MONTHE"></span><span class="target" id="group__compute-concrete-options_1gga58de81e235e838dc7c81613cb99e6070a383316922f2516abe5abe53370284a7f"></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">MONTH</span></span></span><a class="headerlink" href="#_CPPv4N12CalendarUnit5MONTHE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N12CalendarUnit7QUARTERE"> |
| <span id="_CPPv3N12CalendarUnit7QUARTERE"></span><span id="_CPPv2N12CalendarUnit7QUARTERE"></span><span class="target" id="group__compute-concrete-options_1gga58de81e235e838dc7c81613cb99e6070a2127749533f087678c2ff775d060024e"></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">QUARTER</span></span></span><a class="headerlink" href="#_CPPv4N12CalendarUnit7QUARTERE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N12CalendarUnit4YEARE"> |
| <span id="_CPPv3N12CalendarUnit4YEARE"></span><span id="_CPPv2N12CalendarUnit4YEARE"></span><span class="target" id="group__compute-concrete-options_1gga58de81e235e838dc7c81613cb99e6070ad18101729d290479023d5eceeb29c9cf"></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">YEAR</span></span></span><a class="headerlink" href="#_CPPv4N12CalendarUnit4YEARE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="cpp enum"> |
| <dt class="sig sig-object cpp" id="_CPPv415CompareOperator"> |
| <span id="_CPPv315CompareOperator"></span><span id="_CPPv215CompareOperator"></span><span class="target" id="group__compute-concrete-options_1ga3f0e57fcf838846e04ab048849653a73"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">CompareOperator</span></span></span><a class="headerlink" href="#_CPPv415CompareOperator" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p><em>Values:</em></p> |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N15CompareOperator5EQUALE"> |
| <span id="_CPPv3N15CompareOperator5EQUALE"></span><span id="_CPPv2N15CompareOperator5EQUALE"></span><span class="target" id="group__compute-concrete-options_1gga3f0e57fcf838846e04ab048849653a73a602792ae96607227306b00b948a49642"></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">EQUAL</span></span></span><a class="headerlink" href="#_CPPv4N15CompareOperator5EQUALE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N15CompareOperator9NOT_EQUALE"> |
| <span id="_CPPv3N15CompareOperator9NOT_EQUALE"></span><span id="_CPPv2N15CompareOperator9NOT_EQUALE"></span><span class="target" id="group__compute-concrete-options_1gga3f0e57fcf838846e04ab048849653a73a4bcbbc099f2f532f402c86415099f446"></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">NOT_EQUAL</span></span></span><a class="headerlink" href="#_CPPv4N15CompareOperator9NOT_EQUALE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N15CompareOperator7GREATERE"> |
| <span id="_CPPv3N15CompareOperator7GREATERE"></span><span id="_CPPv2N15CompareOperator7GREATERE"></span><span class="target" id="group__compute-concrete-options_1gga3f0e57fcf838846e04ab048849653a73a3da583275ccef5bb978f7c0caf0c93e8"></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">GREATER</span></span></span><a class="headerlink" href="#_CPPv4N15CompareOperator7GREATERE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N15CompareOperator13GREATER_EQUALE"> |
| <span id="_CPPv3N15CompareOperator13GREATER_EQUALE"></span><span id="_CPPv2N15CompareOperator13GREATER_EQUALE"></span><span class="target" id="group__compute-concrete-options_1gga3f0e57fcf838846e04ab048849653a73aafce6452f6406693fc0b4736f343c19a"></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">GREATER_EQUAL</span></span></span><a class="headerlink" href="#_CPPv4N15CompareOperator13GREATER_EQUALE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N15CompareOperator4LESSE"> |
| <span id="_CPPv3N15CompareOperator4LESSE"></span><span id="_CPPv2N15CompareOperator4LESSE"></span><span class="target" id="group__compute-concrete-options_1gga3f0e57fcf838846e04ab048849653a73aece4bea22705948d598457047b45a713"></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">LESS</span></span></span><a class="headerlink" href="#_CPPv4N15CompareOperator4LESSE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N15CompareOperator10LESS_EQUALE"> |
| <span id="_CPPv3N15CompareOperator10LESS_EQUALE"></span><span id="_CPPv2N15CompareOperator10LESS_EQUALE"></span><span class="target" id="group__compute-concrete-options_1gga3f0e57fcf838846e04ab048849653a73ab8cba2f6e6f1cb0afed2d02ee7ed5afa"></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">LESS_EQUAL</span></span></span><a class="headerlink" href="#_CPPv4N15CompareOperator10LESS_EQUALE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="cpp type"> |
| <dt class="sig sig-object cpp" id="_CPPv420CumulativeSumOptions"> |
| <span id="_CPPv320CumulativeSumOptions"></span><span id="_CPPv220CumulativeSumOptions"></span><span class="target" id="group__compute-concrete-options_1ga9ca85b245c32741c0493bbdffa64fc04"></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">CumulativeSumOptions</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">CumulativeOptions</span></span><a class="headerlink" href="#_CPPv420CumulativeSumOptions" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute22ScalarAggregateOptionsE"> |
| <span id="_CPPv3N5arrow7compute22ScalarAggregateOptionsE"></span><span id="_CPPv2N5arrow7compute22ScalarAggregateOptionsE"></span><span id="arrow::compute::ScalarAggregateOptions"></span><span class="target" id="classarrow_1_1compute_1_1_scalar_aggregate_options"></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">ScalarAggregateOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute22ScalarAggregateOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_aggregate.h></em></div> |
| <p>Control general scalar aggregate kernel behavior. </p> |
| <p>By default, null values are ignored (skip_nulls = true). </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="_CPPv4N5arrow7compute22ScalarAggregateOptions22ScalarAggregateOptionsEb8uint32_t"> |
| <span id="_CPPv3N5arrow7compute22ScalarAggregateOptions22ScalarAggregateOptionsEb8uint32_t"></span><span id="_CPPv2N5arrow7compute22ScalarAggregateOptions22ScalarAggregateOptionsEb8uint32_t"></span><span id="arrow::compute::ScalarAggregateOptions::ScalarAggregateOptions__b.uint32_t"></span><span class="target" id="classarrow_1_1compute_1_1_scalar_aggregate_options_1a0de12d3f4e5fea70ac741f0db982a899"></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">ScalarAggregateOptions</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">skip_nulls</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">uint32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">min_count</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">1</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute22ScalarAggregateOptions22ScalarAggregateOptionsEb8uint32_t" 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="_CPPv4N5arrow7compute22ScalarAggregateOptions10skip_nullsE"> |
| <span id="_CPPv3N5arrow7compute22ScalarAggregateOptions10skip_nullsE"></span><span id="_CPPv2N5arrow7compute22ScalarAggregateOptions10skip_nullsE"></span><span id="arrow::compute::ScalarAggregateOptions::skip_nulls__b"></span><span class="target" id="classarrow_1_1compute_1_1_scalar_aggregate_options_1ac0b1c0b6aa3103eac160e0ee48eb7379"></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">skip_nulls</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute22ScalarAggregateOptions10skip_nullsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>If true (the default), null values are ignored. </p> |
| <p>Otherwise, if any value is null, emit null. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute22ScalarAggregateOptions9min_countE"> |
| <span id="_CPPv3N5arrow7compute22ScalarAggregateOptions9min_countE"></span><span id="_CPPv2N5arrow7compute22ScalarAggregateOptions9min_countE"></span><span id="arrow::compute::ScalarAggregateOptions::min_count__uint32_t"></span><span class="target" id="classarrow_1_1compute_1_1_scalar_aggregate_options_1a1650d171aa0974894f3ea01a8b62bea6"></span><span class="n"><span class="pre">uint32_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">min_count</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute22ScalarAggregateOptions9min_countE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>If less than this many non-null values are observed, emit null. </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="_CPPv4N5arrow7compute22ScalarAggregateOptions8DefaultsEv"> |
| <span id="_CPPv3N5arrow7compute22ScalarAggregateOptions8DefaultsEv"></span><span id="_CPPv2N5arrow7compute22ScalarAggregateOptions8DefaultsEv"></span><span id="arrow::compute::ScalarAggregateOptions::Defaults"></span><span class="target" id="classarrow_1_1compute_1_1_scalar_aggregate_options_1aec39954ae82bb9d773924408cc641fc7"></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="#_CPPv4N5arrow7compute22ScalarAggregateOptionsE" title="arrow::compute::ScalarAggregateOptions"><span class="n"><span class="pre">ScalarAggregateOptions</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="#_CPPv4N5arrow7compute22ScalarAggregateOptions8DefaultsEv" 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-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute22ScalarAggregateOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute22ScalarAggregateOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute22ScalarAggregateOptions9kTypeNameE"></span><span id="arrow::compute::ScalarAggregateOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_scalar_aggregate_options_1a14c739318effd4aa6d44d87c6cdb4d64"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"ScalarAggregateOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute22ScalarAggregateOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute12CountOptionsE"> |
| <span id="_CPPv3N5arrow7compute12CountOptionsE"></span><span id="_CPPv2N5arrow7compute12CountOptionsE"></span><span id="arrow::compute::CountOptions"></span><span class="target" id="classarrow_1_1compute_1_1_count_options"></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">CountOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute12CountOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_aggregate.h></em></div> |
| <p>Control count aggregate kernel behavior. </p> |
| <p>By default, only non-null values are counted. </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 enum"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute12CountOptions9CountModeE"> |
| <span id="_CPPv3N5arrow7compute12CountOptions9CountModeE"></span><span id="_CPPv2N5arrow7compute12CountOptions9CountModeE"></span><span class="target" id="classarrow_1_1compute_1_1_count_options_1a7ec04e95f3f31aebf5384f99343b2c40"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">CountMode</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute12CountOptions9CountModeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p><em>Values:</em></p> |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute12CountOptions9CountMode10ONLY_VALIDE"> |
| <span id="_CPPv3N5arrow7compute12CountOptions9CountMode10ONLY_VALIDE"></span><span id="_CPPv2N5arrow7compute12CountOptions9CountMode10ONLY_VALIDE"></span><span class="target" id="classarrow_1_1compute_1_1_count_options_1a7ec04e95f3f31aebf5384f99343b2c40a35e3fe32762ac59ff68f5e5f1ecaecdd"></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">ONLY_VALID</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute12CountOptions9CountMode10ONLY_VALIDE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Count only non-null values. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute12CountOptions9CountMode9ONLY_NULLE"> |
| <span id="_CPPv3N5arrow7compute12CountOptions9CountMode9ONLY_NULLE"></span><span id="_CPPv2N5arrow7compute12CountOptions9CountMode9ONLY_NULLE"></span><span class="target" id="classarrow_1_1compute_1_1_count_options_1a7ec04e95f3f31aebf5384f99343b2c40a441d3d5552dc7a371a635915a95059a0"></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">ONLY_NULL</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute12CountOptions9CountMode9ONLY_NULLE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Count only null values. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute12CountOptions9CountMode3ALLE"> |
| <span id="_CPPv3N5arrow7compute12CountOptions9CountMode3ALLE"></span><span id="_CPPv2N5arrow7compute12CountOptions9CountMode3ALLE"></span><span class="target" id="classarrow_1_1compute_1_1_count_options_1a7ec04e95f3f31aebf5384f99343b2c40a761d51350c66a6160675deeb17792019"></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">ALL</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute12CountOptions9CountMode3ALLE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Count both non-null and null values. </p> |
| </dd></dl> |
| |
| </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="_CPPv4N5arrow7compute12CountOptions12CountOptionsE9CountMode"> |
| <span id="_CPPv3N5arrow7compute12CountOptions12CountOptionsE9CountMode"></span><span id="_CPPv2N5arrow7compute12CountOptions12CountOptionsE9CountMode"></span><span id="arrow::compute::CountOptions::CountOptions__CountMode"></span><span class="target" id="classarrow_1_1compute_1_1_count_options_1a2e3c49e597d5017b8ff7d355c5296271"></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">CountOptions</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4N5arrow7compute12CountOptions9CountModeE" title="arrow::compute::CountOptions::CountMode"><span class="n"><span class="pre">CountMode</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">mode</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow7compute12CountOptions9CountModeE" title="arrow::compute::CountOptions::CountMode"><span class="n"><span class="pre">CountMode</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute12CountOptions9CountMode10ONLY_VALIDE" title="arrow::compute::CountOptions::CountMode::ONLY_VALID"><span class="n"><span class="pre">ONLY_VALID</span></span></a><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute12CountOptions12CountOptionsE9CountMode" 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="_CPPv4N5arrow7compute12CountOptions4modeE"> |
| <span id="_CPPv3N5arrow7compute12CountOptions4modeE"></span><span id="_CPPv2N5arrow7compute12CountOptions4modeE"></span><span id="arrow::compute::CountOptions::mode__CountMode"></span><span class="target" id="classarrow_1_1compute_1_1_count_options_1aa1501224f4914df2ab8d84a8d62437c6"></span><a class="reference internal" href="#_CPPv4N5arrow7compute12CountOptions9CountModeE" title="arrow::compute::CountOptions::CountMode"><span class="n"><span class="pre">CountMode</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">mode</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute12CountOptions4modeE" 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="_CPPv4N5arrow7compute12CountOptions8DefaultsEv"> |
| <span id="_CPPv3N5arrow7compute12CountOptions8DefaultsEv"></span><span id="_CPPv2N5arrow7compute12CountOptions8DefaultsEv"></span><span id="arrow::compute::CountOptions::Defaults"></span><span class="target" id="classarrow_1_1compute_1_1_count_options_1a9abe92d76ece547b1d5c8b0763b91456"></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="#_CPPv4N5arrow7compute12CountOptionsE" title="arrow::compute::CountOptions"><span class="n"><span class="pre">CountOptions</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="#_CPPv4N5arrow7compute12CountOptions8DefaultsEv" 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-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute12CountOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute12CountOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute12CountOptions9kTypeNameE"></span><span id="arrow::compute::CountOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_count_options_1afe70cdf6301b6f927b83997c992dffba"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"CountOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute12CountOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11ModeOptionsE"> |
| <span id="_CPPv3N5arrow7compute11ModeOptionsE"></span><span id="_CPPv2N5arrow7compute11ModeOptionsE"></span><span id="arrow::compute::ModeOptions"></span><span class="target" id="classarrow_1_1compute_1_1_mode_options"></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">ModeOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute11ModeOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_aggregate.h></em></div> |
| <p>Control Mode kernel behavior. </p> |
| <p>Returns top-n common values and counts. By default, returns the most common value and count. </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="_CPPv4N5arrow7compute11ModeOptions11ModeOptionsE7int64_tb8uint32_t"> |
| <span id="_CPPv3N5arrow7compute11ModeOptions11ModeOptionsE7int64_tb8uint32_t"></span><span id="_CPPv2N5arrow7compute11ModeOptions11ModeOptionsE7int64_tb8uint32_t"></span><span id="arrow::compute::ModeOptions::ModeOptions__int64_t.b.uint32_t"></span><span class="target" id="classarrow_1_1compute_1_1_mode_options_1a23588b50284353ec1dda7ff2d3326b00"></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">ModeOptions</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">n</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">1</span></span>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">skip_nulls</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">uint32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">min_count</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><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute11ModeOptions11ModeOptionsE7int64_tb8uint32_t" 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="_CPPv4N5arrow7compute11ModeOptions1nE"> |
| <span id="_CPPv3N5arrow7compute11ModeOptions1nE"></span><span id="_CPPv2N5arrow7compute11ModeOptions1nE"></span><span id="arrow::compute::ModeOptions::n__int64_t"></span><span class="target" id="classarrow_1_1compute_1_1_mode_options_1a328bd2e2f9ab35bc755f403c2029217d"></span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">n</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">1</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11ModeOptions1nE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11ModeOptions10skip_nullsE"> |
| <span id="_CPPv3N5arrow7compute11ModeOptions10skip_nullsE"></span><span id="_CPPv2N5arrow7compute11ModeOptions10skip_nullsE"></span><span id="arrow::compute::ModeOptions::skip_nulls__b"></span><span class="target" id="classarrow_1_1compute_1_1_mode_options_1a94f5803cc63ce600eca9fbe5c82de9c0"></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">skip_nulls</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11ModeOptions10skip_nullsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>If true (the default), null values are ignored. </p> |
| <p>Otherwise, if any value is null, emit null. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11ModeOptions9min_countE"> |
| <span id="_CPPv3N5arrow7compute11ModeOptions9min_countE"></span><span id="_CPPv2N5arrow7compute11ModeOptions9min_countE"></span><span id="arrow::compute::ModeOptions::min_count__uint32_t"></span><span class="target" id="classarrow_1_1compute_1_1_mode_options_1a9dce4041d429100cbc56afb7ef757334"></span><span class="n"><span class="pre">uint32_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">min_count</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11ModeOptions9min_countE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>If less than this many non-null values are observed, emit null. </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="_CPPv4N5arrow7compute11ModeOptions8DefaultsEv"> |
| <span id="_CPPv3N5arrow7compute11ModeOptions8DefaultsEv"></span><span id="_CPPv2N5arrow7compute11ModeOptions8DefaultsEv"></span><span id="arrow::compute::ModeOptions::Defaults"></span><span class="target" id="classarrow_1_1compute_1_1_mode_options_1a9428e1a7c81f37c4bf37fce425a47998"></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="#_CPPv4N5arrow7compute11ModeOptionsE" title="arrow::compute::ModeOptions"><span class="n"><span class="pre">ModeOptions</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="#_CPPv4N5arrow7compute11ModeOptions8DefaultsEv" 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-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11ModeOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute11ModeOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute11ModeOptions9kTypeNameE"></span><span id="arrow::compute::ModeOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_mode_options_1ac2551b488e0522a149c80f9aece7206b"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"ModeOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11ModeOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute15VarianceOptionsE"> |
| <span id="_CPPv3N5arrow7compute15VarianceOptionsE"></span><span id="_CPPv2N5arrow7compute15VarianceOptionsE"></span><span id="arrow::compute::VarianceOptions"></span><span class="target" id="classarrow_1_1compute_1_1_variance_options"></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">VarianceOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute15VarianceOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_aggregate.h></em></div> |
| <p>Control Delta Degrees of Freedom (ddof) of Variance and Stddev kernel. </p> |
| <p>The divisor used in calculations is N - ddof, where N is the number of elements. By default, ddof is zero, and population variance or stddev is returned. </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="_CPPv4N5arrow7compute15VarianceOptions15VarianceOptionsEib8uint32_t"> |
| <span id="_CPPv3N5arrow7compute15VarianceOptions15VarianceOptionsEib8uint32_t"></span><span id="_CPPv2N5arrow7compute15VarianceOptions15VarianceOptionsEib8uint32_t"></span><span id="arrow::compute::VarianceOptions::VarianceOptions__i.b.uint32_t"></span><span class="target" id="classarrow_1_1compute_1_1_variance_options_1a59e07982a03b85c729fab1ca7e6723ff"></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">VarianceOptions</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">ddof</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>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">skip_nulls</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">uint32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">min_count</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><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute15VarianceOptions15VarianceOptionsEib8uint32_t" 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="_CPPv4N5arrow7compute15VarianceOptions4ddofE"> |
| <span id="_CPPv3N5arrow7compute15VarianceOptions4ddofE"></span><span id="_CPPv2N5arrow7compute15VarianceOptions4ddofE"></span><span id="arrow::compute::VarianceOptions::ddof__i"></span><span class="target" id="classarrow_1_1compute_1_1_variance_options_1a8da5eca4f1c0f337f3f23236dc7970cb"></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">ddof</span></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="#_CPPv4N5arrow7compute15VarianceOptions4ddofE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute15VarianceOptions10skip_nullsE"> |
| <span id="_CPPv3N5arrow7compute15VarianceOptions10skip_nullsE"></span><span id="_CPPv2N5arrow7compute15VarianceOptions10skip_nullsE"></span><span id="arrow::compute::VarianceOptions::skip_nulls__b"></span><span class="target" id="classarrow_1_1compute_1_1_variance_options_1a6aacb6c12f81ccd49865d1fa37b53458"></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">skip_nulls</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute15VarianceOptions10skip_nullsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>If true (the default), null values are ignored. </p> |
| <p>Otherwise, if any value is null, emit null. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute15VarianceOptions9min_countE"> |
| <span id="_CPPv3N5arrow7compute15VarianceOptions9min_countE"></span><span id="_CPPv2N5arrow7compute15VarianceOptions9min_countE"></span><span id="arrow::compute::VarianceOptions::min_count__uint32_t"></span><span class="target" id="classarrow_1_1compute_1_1_variance_options_1af2ddf3bbb81228a37bfae1d8a3274162"></span><span class="n"><span class="pre">uint32_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">min_count</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute15VarianceOptions9min_countE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>If less than this many non-null values are observed, emit null. </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="_CPPv4N5arrow7compute15VarianceOptions8DefaultsEv"> |
| <span id="_CPPv3N5arrow7compute15VarianceOptions8DefaultsEv"></span><span id="_CPPv2N5arrow7compute15VarianceOptions8DefaultsEv"></span><span id="arrow::compute::VarianceOptions::Defaults"></span><span class="target" id="classarrow_1_1compute_1_1_variance_options_1a209a6cacd2c57368c323c3362393d24e"></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="#_CPPv4N5arrow7compute15VarianceOptionsE" title="arrow::compute::VarianceOptions"><span class="n"><span class="pre">VarianceOptions</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="#_CPPv4N5arrow7compute15VarianceOptions8DefaultsEv" 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-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute15VarianceOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute15VarianceOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute15VarianceOptions9kTypeNameE"></span><span id="arrow::compute::VarianceOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_variance_options_1ab9021bded309cf22e632e99f55ecbe28"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"VarianceOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute15VarianceOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute15QuantileOptionsE"> |
| <span id="_CPPv3N5arrow7compute15QuantileOptionsE"></span><span id="_CPPv2N5arrow7compute15QuantileOptionsE"></span><span id="arrow::compute::QuantileOptions"></span><span class="target" id="classarrow_1_1compute_1_1_quantile_options"></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">QuantileOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute15QuantileOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_aggregate.h></em></div> |
| <p>Control Quantile kernel behavior. </p> |
| <p>By default, returns the median value. </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 enum"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute15QuantileOptions13InterpolationE"> |
| <span id="_CPPv3N5arrow7compute15QuantileOptions13InterpolationE"></span><span id="_CPPv2N5arrow7compute15QuantileOptions13InterpolationE"></span><span class="target" id="classarrow_1_1compute_1_1_quantile_options_1a5e9deaacad5cfdb76479c5765e418bed"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Interpolation</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute15QuantileOptions13InterpolationE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Interpolation method to use when quantile lies between two data points. </p> |
| <p><em>Values:</em></p> |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute15QuantileOptions13Interpolation6LINEARE"> |
| <span id="_CPPv3N5arrow7compute15QuantileOptions13Interpolation6LINEARE"></span><span id="_CPPv2N5arrow7compute15QuantileOptions13Interpolation6LINEARE"></span><span class="target" id="classarrow_1_1compute_1_1_quantile_options_1a5e9deaacad5cfdb76479c5765e418beda3eb20ae7fe6e7b70b593743243f4956d"></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">LINEAR</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute15QuantileOptions13Interpolation6LINEARE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute15QuantileOptions13Interpolation5LOWERE"> |
| <span id="_CPPv3N5arrow7compute15QuantileOptions13Interpolation5LOWERE"></span><span id="_CPPv2N5arrow7compute15QuantileOptions13Interpolation5LOWERE"></span><span class="target" id="classarrow_1_1compute_1_1_quantile_options_1a5e9deaacad5cfdb76479c5765e418bedaec7685530917fdb7abdb3f0d847ad894"></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">LOWER</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute15QuantileOptions13Interpolation5LOWERE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute15QuantileOptions13Interpolation6HIGHERE"> |
| <span id="_CPPv3N5arrow7compute15QuantileOptions13Interpolation6HIGHERE"></span><span id="_CPPv2N5arrow7compute15QuantileOptions13Interpolation6HIGHERE"></span><span class="target" id="classarrow_1_1compute_1_1_quantile_options_1a5e9deaacad5cfdb76479c5765e418beda842d751fcd7584c3e48448ae03017d38"></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">HIGHER</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute15QuantileOptions13Interpolation6HIGHERE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute15QuantileOptions13Interpolation7NEARESTE"> |
| <span id="_CPPv3N5arrow7compute15QuantileOptions13Interpolation7NEARESTE"></span><span id="_CPPv2N5arrow7compute15QuantileOptions13Interpolation7NEARESTE"></span><span class="target" id="classarrow_1_1compute_1_1_quantile_options_1a5e9deaacad5cfdb76479c5765e418beda5d3a37602f4257e46d0138067694dd00"></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">NEAREST</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute15QuantileOptions13Interpolation7NEARESTE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute15QuantileOptions13Interpolation8MIDPOINTE"> |
| <span id="_CPPv3N5arrow7compute15QuantileOptions13Interpolation8MIDPOINTE"></span><span id="_CPPv2N5arrow7compute15QuantileOptions13Interpolation8MIDPOINTE"></span><span class="target" id="classarrow_1_1compute_1_1_quantile_options_1a5e9deaacad5cfdb76479c5765e418bedabd1fe3a72ed59a1738fd8e53c3c72782"></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">MIDPOINT</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute15QuantileOptions13Interpolation8MIDPOINTE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </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="_CPPv4N5arrow7compute15QuantileOptions15QuantileOptionsEd13Interpolationb8uint32_t"> |
| <span id="_CPPv3N5arrow7compute15QuantileOptions15QuantileOptionsEd13Interpolationb8uint32_t"></span><span id="_CPPv2N5arrow7compute15QuantileOptions15QuantileOptionsEd13Interpolationb8uint32_t"></span><span id="arrow::compute::QuantileOptions::QuantileOptions__double.Interpolation.b.uint32_t"></span><span class="target" id="classarrow_1_1compute_1_1_quantile_options_1affc4e6585558852cedfeb83640f6becf"></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">QuantileOptions</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">double</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">q</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.5</span></span>, <span class="k"><span class="pre">enum</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow7compute15QuantileOptions13InterpolationE" title="arrow::compute::QuantileOptions::Interpolation"><span class="n"><span class="pre">Interpolation</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">interpolation</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow7compute15QuantileOptions13Interpolation6LINEARE" title="arrow::compute::QuantileOptions::LINEAR"><span class="n"><span class="pre">LINEAR</span></span></a>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">skip_nulls</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">uint32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">min_count</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><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute15QuantileOptions15QuantileOptionsEd13Interpolationb8uint32_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute15QuantileOptions15QuantileOptionsENSt6vectorIdEE13Interpolationb8uint32_t"> |
| <span id="_CPPv3N5arrow7compute15QuantileOptions15QuantileOptionsENSt6vectorIdEE13Interpolationb8uint32_t"></span><span id="_CPPv2N5arrow7compute15QuantileOptions15QuantileOptionsENSt6vectorIdEE13Interpolationb8uint32_t"></span><span id="arrow::compute::QuantileOptions::QuantileOptions__std::vector:double:.Interpolation.b.uint32_t"></span><span class="target" id="classarrow_1_1compute_1_1_quantile_options_1a2c2bd8a33a15f59b41e2b71d564c20e1"></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">QuantileOptions</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">double</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">q</span></span>, <span class="k"><span class="pre">enum</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow7compute15QuantileOptions13InterpolationE" title="arrow::compute::QuantileOptions::Interpolation"><span class="n"><span class="pre">Interpolation</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">interpolation</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow7compute15QuantileOptions13Interpolation6LINEARE" title="arrow::compute::QuantileOptions::LINEAR"><span class="n"><span class="pre">LINEAR</span></span></a>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">skip_nulls</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">uint32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">min_count</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><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute15QuantileOptions15QuantileOptionsENSt6vectorIdEE13Interpolationb8uint32_t" 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="_CPPv4N5arrow7compute15QuantileOptions1qE"> |
| <span id="_CPPv3N5arrow7compute15QuantileOptions1qE"></span><span id="_CPPv2N5arrow7compute15QuantileOptions1qE"></span><span id="arrow::compute::QuantileOptions::q__std::vector:double:"></span><span class="target" id="classarrow_1_1compute_1_1_quantile_options_1ac4676183434c7d1541fed992659f1a07"></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">double</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">q</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute15QuantileOptions1qE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>probability level of quantile must be between 0 and 1 inclusive </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute15QuantileOptions13interpolationE"> |
| <span id="_CPPv3N5arrow7compute15QuantileOptions13interpolationE"></span><span id="_CPPv2N5arrow7compute15QuantileOptions13interpolationE"></span><span id="arrow::compute::QuantileOptions::interpolation__Interpolation"></span><span class="target" id="classarrow_1_1compute_1_1_quantile_options_1ab867e3d8a24746c519c87fd6a73e3c78"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow7compute15QuantileOptions13InterpolationE" title="arrow::compute::QuantileOptions::Interpolation"><span class="n"><span class="pre">Interpolation</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">interpolation</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute15QuantileOptions13interpolationE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute15QuantileOptions10skip_nullsE"> |
| <span id="_CPPv3N5arrow7compute15QuantileOptions10skip_nullsE"></span><span id="_CPPv2N5arrow7compute15QuantileOptions10skip_nullsE"></span><span id="arrow::compute::QuantileOptions::skip_nulls__b"></span><span class="target" id="classarrow_1_1compute_1_1_quantile_options_1a06c6a0ed1f941a07b0b8893b2d1d614d"></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">skip_nulls</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute15QuantileOptions10skip_nullsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>If true (the default), null values are ignored. </p> |
| <p>Otherwise, if any value is null, emit null. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute15QuantileOptions9min_countE"> |
| <span id="_CPPv3N5arrow7compute15QuantileOptions9min_countE"></span><span id="_CPPv2N5arrow7compute15QuantileOptions9min_countE"></span><span id="arrow::compute::QuantileOptions::min_count__uint32_t"></span><span class="target" id="classarrow_1_1compute_1_1_quantile_options_1a16089ff314aa4d7f2fd785ea9fe22c2f"></span><span class="n"><span class="pre">uint32_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">min_count</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute15QuantileOptions9min_countE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>If less than this many non-null values are observed, emit null. </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="_CPPv4N5arrow7compute15QuantileOptions8DefaultsEv"> |
| <span id="_CPPv3N5arrow7compute15QuantileOptions8DefaultsEv"></span><span id="_CPPv2N5arrow7compute15QuantileOptions8DefaultsEv"></span><span id="arrow::compute::QuantileOptions::Defaults"></span><span class="target" id="classarrow_1_1compute_1_1_quantile_options_1a08dd846a5ba1fedb6cbbce17fc6715a1"></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="#_CPPv4N5arrow7compute15QuantileOptionsE" title="arrow::compute::QuantileOptions"><span class="n"><span class="pre">QuantileOptions</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="#_CPPv4N5arrow7compute15QuantileOptions8DefaultsEv" 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-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute15QuantileOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute15QuantileOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute15QuantileOptions9kTypeNameE"></span><span id="arrow::compute::QuantileOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_quantile_options_1acdd795e89a7863493f8a0dcaa6eb6dbe"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"QuantileOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute15QuantileOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute14TDigestOptionsE"> |
| <span id="_CPPv3N5arrow7compute14TDigestOptionsE"></span><span id="_CPPv2N5arrow7compute14TDigestOptionsE"></span><span id="arrow::compute::TDigestOptions"></span><span class="target" id="classarrow_1_1compute_1_1_t_digest_options"></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">TDigestOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute14TDigestOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_aggregate.h></em></div> |
| <p>Control TDigest approximate quantile kernel behavior. </p> |
| <p>By default, returns the median value. </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="_CPPv4N5arrow7compute14TDigestOptions14TDigestOptionsEd8uint32_t8uint32_tb8uint32_t"> |
| <span id="_CPPv3N5arrow7compute14TDigestOptions14TDigestOptionsEd8uint32_t8uint32_tb8uint32_t"></span><span id="_CPPv2N5arrow7compute14TDigestOptions14TDigestOptionsEd8uint32_t8uint32_tb8uint32_t"></span><span id="arrow::compute::TDigestOptions::TDigestOptions__double.uint32_t.uint32_t.b.uint32_t"></span><span class="target" id="classarrow_1_1compute_1_1_t_digest_options_1a6696637fc9511ab82027633ea7b3292e"></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">TDigestOptions</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">double</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">q</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.5</span></span>, <span class="n"><span class="pre">uint32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">delta</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">100</span></span>, <span class="n"><span class="pre">uint32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">buffer_size</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">500</span></span>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">skip_nulls</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">uint32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">min_count</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><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute14TDigestOptions14TDigestOptionsEd8uint32_t8uint32_tb8uint32_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute14TDigestOptions14TDigestOptionsENSt6vectorIdEE8uint32_t8uint32_tb8uint32_t"> |
| <span id="_CPPv3N5arrow7compute14TDigestOptions14TDigestOptionsENSt6vectorIdEE8uint32_t8uint32_tb8uint32_t"></span><span id="_CPPv2N5arrow7compute14TDigestOptions14TDigestOptionsENSt6vectorIdEE8uint32_t8uint32_tb8uint32_t"></span><span id="arrow::compute::TDigestOptions::TDigestOptions__std::vector:double:.uint32_t.uint32_t.b.uint32_t"></span><span class="target" id="classarrow_1_1compute_1_1_t_digest_options_1a150dcd753225aaf6c9ca1adc6838605e"></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">TDigestOptions</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">double</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">q</span></span>, <span class="n"><span class="pre">uint32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">delta</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">100</span></span>, <span class="n"><span class="pre">uint32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">buffer_size</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">500</span></span>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">skip_nulls</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">uint32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">min_count</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><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute14TDigestOptions14TDigestOptionsENSt6vectorIdEE8uint32_t8uint32_tb8uint32_t" 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="_CPPv4N5arrow7compute14TDigestOptions1qE"> |
| <span id="_CPPv3N5arrow7compute14TDigestOptions1qE"></span><span id="_CPPv2N5arrow7compute14TDigestOptions1qE"></span><span id="arrow::compute::TDigestOptions::q__std::vector:double:"></span><span class="target" id="classarrow_1_1compute_1_1_t_digest_options_1a63732dec62704b1b7ec7b646f98673c6"></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">double</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">q</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute14TDigestOptions1qE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>probability level of quantile must be between 0 and 1 inclusive </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute14TDigestOptions5deltaE"> |
| <span id="_CPPv3N5arrow7compute14TDigestOptions5deltaE"></span><span id="_CPPv2N5arrow7compute14TDigestOptions5deltaE"></span><span id="arrow::compute::TDigestOptions::delta__uint32_t"></span><span class="target" id="classarrow_1_1compute_1_1_t_digest_options_1acf689bff6ddfb0ea2985a31ffefc5efc"></span><span class="n"><span class="pre">uint32_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">delta</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute14TDigestOptions5deltaE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>compression parameter, default 100 </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute14TDigestOptions11buffer_sizeE"> |
| <span id="_CPPv3N5arrow7compute14TDigestOptions11buffer_sizeE"></span><span id="_CPPv2N5arrow7compute14TDigestOptions11buffer_sizeE"></span><span id="arrow::compute::TDigestOptions::buffer_size__uint32_t"></span><span class="target" id="classarrow_1_1compute_1_1_t_digest_options_1a294c5390c63b90c08d07be14e9c27038"></span><span class="n"><span class="pre">uint32_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">buffer_size</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute14TDigestOptions11buffer_sizeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>input buffer size, default 500 </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute14TDigestOptions10skip_nullsE"> |
| <span id="_CPPv3N5arrow7compute14TDigestOptions10skip_nullsE"></span><span id="_CPPv2N5arrow7compute14TDigestOptions10skip_nullsE"></span><span id="arrow::compute::TDigestOptions::skip_nulls__b"></span><span class="target" id="classarrow_1_1compute_1_1_t_digest_options_1a4daa64195c8b5acfd9414a08c1cbf687"></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">skip_nulls</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute14TDigestOptions10skip_nullsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>If true (the default), null values are ignored. </p> |
| <p>Otherwise, if any value is null, emit null. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute14TDigestOptions9min_countE"> |
| <span id="_CPPv3N5arrow7compute14TDigestOptions9min_countE"></span><span id="_CPPv2N5arrow7compute14TDigestOptions9min_countE"></span><span id="arrow::compute::TDigestOptions::min_count__uint32_t"></span><span class="target" id="classarrow_1_1compute_1_1_t_digest_options_1acb7e8d146fcb89c84a5e9d79c6b0ad0b"></span><span class="n"><span class="pre">uint32_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">min_count</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute14TDigestOptions9min_countE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>If less than this many non-null values are observed, emit null. </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="_CPPv4N5arrow7compute14TDigestOptions8DefaultsEv"> |
| <span id="_CPPv3N5arrow7compute14TDigestOptions8DefaultsEv"></span><span id="_CPPv2N5arrow7compute14TDigestOptions8DefaultsEv"></span><span id="arrow::compute::TDigestOptions::Defaults"></span><span class="target" id="classarrow_1_1compute_1_1_t_digest_options_1aabe098c3f13a303197adac414b7a551f"></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="#_CPPv4N5arrow7compute14TDigestOptionsE" title="arrow::compute::TDigestOptions"><span class="n"><span class="pre">TDigestOptions</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="#_CPPv4N5arrow7compute14TDigestOptions8DefaultsEv" 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-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute14TDigestOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute14TDigestOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute14TDigestOptions9kTypeNameE"></span><span id="arrow::compute::TDigestOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_t_digest_options_1a1ecf34ac024fb91ee3d08f17db54bb99"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"TDigestOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute14TDigestOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute12IndexOptionsE"> |
| <span id="_CPPv3N5arrow7compute12IndexOptionsE"></span><span id="_CPPv2N5arrow7compute12IndexOptionsE"></span><span id="arrow::compute::IndexOptions"></span><span class="target" id="classarrow_1_1compute_1_1_index_options"></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">IndexOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute12IndexOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_aggregate.h></em></div> |
| <p>Control Index kernel behavior. </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="_CPPv4N5arrow7compute12IndexOptions12IndexOptionsENSt10shared_ptrI6ScalarEE"> |
| <span id="_CPPv3N5arrow7compute12IndexOptions12IndexOptionsENSt10shared_ptrI6ScalarEE"></span><span id="_CPPv2N5arrow7compute12IndexOptions12IndexOptionsENSt10shared_ptrI6ScalarEE"></span><span id="arrow::compute::IndexOptions::IndexOptions__std::shared_ptr:Scalar:"></span><span class="target" id="classarrow_1_1compute_1_1_index_options_1ac950ae9e7b532c8e8a8869a9ccea6735"></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">IndexOptions</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="scalar.html#_CPPv4N5arrow6ScalarE" title="arrow::Scalar"><span class="n"><span class="pre">Scalar</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">value</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute12IndexOptions12IndexOptionsENSt10shared_ptrI6ScalarEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute12IndexOptions12IndexOptionsEv"> |
| <span id="_CPPv3N5arrow7compute12IndexOptions12IndexOptionsEv"></span><span id="_CPPv2N5arrow7compute12IndexOptions12IndexOptionsEv"></span><span id="arrow::compute::IndexOptions::IndexOptions"></span><span class="target" id="classarrow_1_1compute_1_1_index_options_1a615790a18cb35248b0e90192c9f86e87"></span><span class="sig-name descname"><span class="n"><span class="pre">IndexOptions</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute12IndexOptions12IndexOptionsEv" 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="_CPPv4N5arrow7compute12IndexOptions5valueE"> |
| <span id="_CPPv3N5arrow7compute12IndexOptions5valueE"></span><span id="_CPPv2N5arrow7compute12IndexOptions5valueE"></span><span id="arrow::compute::IndexOptions::value__std::shared_ptr:Scalar:"></span><span class="target" id="classarrow_1_1compute_1_1_index_options_1abdbbdfaeba3dd023bcf9227afd55d98a"></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="scalar.html#_CPPv4N5arrow6ScalarE" title="arrow::Scalar"><span class="n"><span class="pre">Scalar</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">value</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute12IndexOptions5valueE" 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-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute12IndexOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute12IndexOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute12IndexOptions9kTypeNameE"></span><span id="arrow::compute::IndexOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_index_options_1a7ed224fad3a44a2bcdbd0ad711fef325"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"IndexOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute12IndexOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute9AggregateE"> |
| <span id="_CPPv3N5arrow7compute9AggregateE"></span><span id="_CPPv2N5arrow7compute9AggregateE"></span><span id="arrow::compute::Aggregate"></span><span class="target" id="structarrow_1_1compute_1_1_aggregate"></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">Aggregate</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute9AggregateE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_aggregate.h></em></div> |
| <p>Configure a grouped aggregation. </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="_CPPv4N5arrow7compute9Aggregate9AggregateEv"> |
| <span id="_CPPv3N5arrow7compute9Aggregate9AggregateEv"></span><span id="_CPPv2N5arrow7compute9Aggregate9AggregateEv"></span><span id="arrow::compute::Aggregate::Aggregate"></span><span class="target" id="structarrow_1_1compute_1_1_aggregate_1a591338ccc05c0606aa30b9486ffe8d34"></span><span class="sig-name descname"><span class="n"><span class="pre">Aggregate</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="#_CPPv4N5arrow7compute9Aggregate9AggregateEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute9Aggregate9AggregateENSt6stringENSt10shared_ptrI15FunctionOptionsEENSt6vectorI8FieldRefEENSt6stringE"> |
| <span id="_CPPv3N5arrow7compute9Aggregate9AggregateENSt6stringENSt10shared_ptrI15FunctionOptionsEENSt6vectorI8FieldRefEENSt6stringE"></span><span id="_CPPv2N5arrow7compute9Aggregate9AggregateENSt6stringENSt10shared_ptrI15FunctionOptionsEENSt6vectorI8FieldRefEENSt6stringE"></span><span id="arrow::compute::Aggregate::Aggregate__ss.std::shared_ptr:FunctionOptions:.std::vector:FieldRef:.ss"></span><span class="target" id="structarrow_1_1compute_1_1_aggregate_1a2e7a0ba7d265a3a905a63e578f725340"></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">Aggregate</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">function</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="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">options</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="datatype.html#_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="n sig-param"><span class="pre">target</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="w"> </span><span class="n sig-param"><span class="pre">name</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">""</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute9Aggregate9AggregateENSt6stringENSt10shared_ptrI15FunctionOptionsEENSt6vectorI8FieldRefEENSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute9Aggregate9AggregateENSt6stringENSt10shared_ptrI15FunctionOptionsEE8FieldRefNSt6stringE"> |
| <span id="_CPPv3N5arrow7compute9Aggregate9AggregateENSt6stringENSt10shared_ptrI15FunctionOptionsEE8FieldRefNSt6stringE"></span><span id="_CPPv2N5arrow7compute9Aggregate9AggregateENSt6stringENSt10shared_ptrI15FunctionOptionsEE8FieldRefNSt6stringE"></span><span id="arrow::compute::Aggregate::Aggregate__ss.std::shared_ptr:FunctionOptions:.FieldRef.ss"></span><span class="target" id="structarrow_1_1compute_1_1_aggregate_1a55266edd83f90b550a6971a5c9fea6ed"></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">Aggregate</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">function</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="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">options</span></span>, <a class="reference internal" href="datatype.html#_CPPv4N5arrow8FieldRefE" title="arrow::FieldRef"><span class="n"><span class="pre">FieldRef</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">target</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="w"> </span><span class="n sig-param"><span class="pre">name</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">""</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute9Aggregate9AggregateENSt6stringENSt10shared_ptrI15FunctionOptionsEE8FieldRefNSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute9Aggregate9AggregateENSt6stringE8FieldRefNSt6stringE"> |
| <span id="_CPPv3N5arrow7compute9Aggregate9AggregateENSt6stringE8FieldRefNSt6stringE"></span><span id="_CPPv2N5arrow7compute9Aggregate9AggregateENSt6stringE8FieldRefNSt6stringE"></span><span id="arrow::compute::Aggregate::Aggregate__ss.FieldRef.ss"></span><span class="target" id="structarrow_1_1compute_1_1_aggregate_1a279395eef8ece57a2db64dc724c90187"></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">Aggregate</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">function</span></span>, <a class="reference internal" href="datatype.html#_CPPv4N5arrow8FieldRefE" title="arrow::FieldRef"><span class="n"><span class="pre">FieldRef</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">target</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="w"> </span><span class="n sig-param"><span class="pre">name</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute9Aggregate9AggregateENSt6stringE8FieldRefNSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute9Aggregate9AggregateENSt6stringENSt6stringE"> |
| <span id="_CPPv3N5arrow7compute9Aggregate9AggregateENSt6stringENSt6stringE"></span><span id="_CPPv2N5arrow7compute9Aggregate9AggregateENSt6stringENSt6stringE"></span><span id="arrow::compute::Aggregate::Aggregate__ss.ss"></span><span class="target" id="structarrow_1_1compute_1_1_aggregate_1a9e7bc19d297534e30b89766388893d1c"></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">Aggregate</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">function</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="w"> </span><span class="n sig-param"><span class="pre">name</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute9Aggregate9AggregateENSt6stringENSt6stringE" 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="_CPPv4N5arrow7compute9Aggregate8functionE"> |
| <span id="_CPPv3N5arrow7compute9Aggregate8functionE"></span><span id="_CPPv2N5arrow7compute9Aggregate8functionE"></span><span id="arrow::compute::Aggregate::function__ss"></span><span class="target" id="structarrow_1_1compute_1_1_aggregate_1ad00b6eabd2b14039f19109cac27dcae1"></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">function</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute9Aggregate8functionE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>the name of the aggregation function </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute9Aggregate7optionsE"> |
| <span id="_CPPv3N5arrow7compute9Aggregate7optionsE"></span><span id="_CPPv2N5arrow7compute9Aggregate7optionsE"></span><span id="arrow::compute::Aggregate::options__std::shared_ptr:FunctionOptions:"></span><span class="target" id="structarrow_1_1compute_1_1_aggregate_1a0a913372406da18fc4ffbbc3e96f1f7a"></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="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</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">options</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute9Aggregate7optionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>options for the aggregation function </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute9Aggregate6targetE"> |
| <span id="_CPPv3N5arrow7compute9Aggregate6targetE"></span><span id="_CPPv2N5arrow7compute9Aggregate6targetE"></span><span id="arrow::compute::Aggregate::target__std::vector:FieldRef:"></span><span class="target" id="structarrow_1_1compute_1_1_aggregate_1a01565491abdbbba03d3426c21a370522"></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="datatype.html#_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">target</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute9Aggregate6targetE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>zero or more fields to which aggregations will be applied </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute9Aggregate4nameE"> |
| <span id="_CPPv3N5arrow7compute9Aggregate4nameE"></span><span id="_CPPv2N5arrow7compute9Aggregate4nameE"></span><span id="arrow::compute::Aggregate::name__ss"></span><span class="target" id="structarrow_1_1compute_1_1_aggregate_1a7613845c8af249f16e8431f8752b5eff"></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><a class="headerlink" href="#_CPPv4N5arrow7compute9Aggregate4nameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>optional output field name for aggregations </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute17ArithmeticOptionsE"> |
| <span id="_CPPv3N5arrow7compute17ArithmeticOptionsE"></span><span id="_CPPv2N5arrow7compute17ArithmeticOptionsE"></span><span id="arrow::compute::ArithmeticOptions"></span><span class="target" id="classarrow_1_1compute_1_1_arithmetic_options"></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">ArithmeticOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute17ArithmeticOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_scalar.h></em></div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute17ArithmeticOptions17ArithmeticOptionsEb"> |
| <span id="_CPPv3N5arrow7compute17ArithmeticOptions17ArithmeticOptionsEb"></span><span id="_CPPv2N5arrow7compute17ArithmeticOptions17ArithmeticOptionsEb"></span><span id="arrow::compute::ArithmeticOptions::ArithmeticOptions__b"></span><span class="target" id="classarrow_1_1compute_1_1_arithmetic_options_1a2d119cab5b72011ed61e7269024f3aaa"></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">ArithmeticOptions</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">check_overflow</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="#_CPPv4N5arrow7compute17ArithmeticOptions17ArithmeticOptionsEb" 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="_CPPv4N5arrow7compute17ArithmeticOptions14check_overflowE"> |
| <span id="_CPPv3N5arrow7compute17ArithmeticOptions14check_overflowE"></span><span id="_CPPv2N5arrow7compute17ArithmeticOptions14check_overflowE"></span><span id="arrow::compute::ArithmeticOptions::check_overflow__b"></span><span class="target" id="classarrow_1_1compute_1_1_arithmetic_options_1a4cf15d69765f2e6c15fcfbb763433441"></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">check_overflow</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute17ArithmeticOptions14check_overflowE" 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-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute17ArithmeticOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute17ArithmeticOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute17ArithmeticOptions9kTypeNameE"></span><span id="arrow::compute::ArithmeticOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_arithmetic_options_1a3ee407ba325446fe803b4fd80a2eda8a"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"ArithmeticOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute17ArithmeticOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute27ElementWiseAggregateOptionsE"> |
| <span id="_CPPv3N5arrow7compute27ElementWiseAggregateOptionsE"></span><span id="_CPPv2N5arrow7compute27ElementWiseAggregateOptionsE"></span><span id="arrow::compute::ElementWiseAggregateOptions"></span><span class="target" id="classarrow_1_1compute_1_1_element_wise_aggregate_options"></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">ElementWiseAggregateOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute27ElementWiseAggregateOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_scalar.h></em></div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute27ElementWiseAggregateOptions27ElementWiseAggregateOptionsEb"> |
| <span id="_CPPv3N5arrow7compute27ElementWiseAggregateOptions27ElementWiseAggregateOptionsEb"></span><span id="_CPPv2N5arrow7compute27ElementWiseAggregateOptions27ElementWiseAggregateOptionsEb"></span><span id="arrow::compute::ElementWiseAggregateOptions::ElementWiseAggregateOptions__b"></span><span class="target" id="classarrow_1_1compute_1_1_element_wise_aggregate_options_1a293287e48f0bec562cd76f7a2142cb83"></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">ElementWiseAggregateOptions</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">skip_nulls</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="k"><span class="pre">true</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute27ElementWiseAggregateOptions27ElementWiseAggregateOptionsEb" 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="_CPPv4N5arrow7compute27ElementWiseAggregateOptions10skip_nullsE"> |
| <span id="_CPPv3N5arrow7compute27ElementWiseAggregateOptions10skip_nullsE"></span><span id="_CPPv2N5arrow7compute27ElementWiseAggregateOptions10skip_nullsE"></span><span id="arrow::compute::ElementWiseAggregateOptions::skip_nulls__b"></span><span class="target" id="classarrow_1_1compute_1_1_element_wise_aggregate_options_1a9cd4695496777b85a2122af36c0d2df7"></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">skip_nulls</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute27ElementWiseAggregateOptions10skip_nullsE" 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="_CPPv4N5arrow7compute27ElementWiseAggregateOptions8DefaultsEv"> |
| <span id="_CPPv3N5arrow7compute27ElementWiseAggregateOptions8DefaultsEv"></span><span id="_CPPv2N5arrow7compute27ElementWiseAggregateOptions8DefaultsEv"></span><span id="arrow::compute::ElementWiseAggregateOptions::Defaults"></span><span class="target" id="classarrow_1_1compute_1_1_element_wise_aggregate_options_1a495c1ac882c6da21a93f914943bcae61"></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="#_CPPv4N5arrow7compute27ElementWiseAggregateOptionsE" title="arrow::compute::ElementWiseAggregateOptions"><span class="n"><span class="pre">ElementWiseAggregateOptions</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="#_CPPv4N5arrow7compute27ElementWiseAggregateOptions8DefaultsEv" 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-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute27ElementWiseAggregateOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute27ElementWiseAggregateOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute27ElementWiseAggregateOptions9kTypeNameE"></span><span id="arrow::compute::ElementWiseAggregateOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_element_wise_aggregate_options_1acf645db5235aa935ad5ee8546f7e8f26"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"ElementWiseAggregateOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute27ElementWiseAggregateOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute12RoundOptionsE"> |
| <span id="_CPPv3N5arrow7compute12RoundOptionsE"></span><span id="_CPPv2N5arrow7compute12RoundOptionsE"></span><span id="arrow::compute::RoundOptions"></span><span class="target" id="classarrow_1_1compute_1_1_round_options"></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">RoundOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute12RoundOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_scalar.h></em></div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute12RoundOptions12RoundOptionsE7int64_t9RoundMode"> |
| <span id="_CPPv3N5arrow7compute12RoundOptions12RoundOptionsE7int64_t9RoundMode"></span><span id="_CPPv2N5arrow7compute12RoundOptions12RoundOptionsE7int64_t9RoundMode"></span><span id="arrow::compute::RoundOptions::RoundOptions__int64_t.RoundMode"></span><span class="target" id="classarrow_1_1compute_1_1_round_options_1a9dbf1e808b4435034f9910a60349e40e"></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">RoundOptions</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">ndigits</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="reference internal" href="#_CPPv49RoundMode" title="RoundMode"><span class="n"><span class="pre">RoundMode</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">round_mode</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv49RoundMode" title="RoundMode"><span class="n"><span class="pre">RoundMode</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N9RoundMode12HALF_TO_EVENE" title="RoundMode::HALF_TO_EVEN"><span class="n"><span class="pre">HALF_TO_EVEN</span></span></a><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute12RoundOptions12RoundOptionsE7int64_t9RoundMode" 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="_CPPv4N5arrow7compute12RoundOptions7ndigitsE"> |
| <span id="_CPPv3N5arrow7compute12RoundOptions7ndigitsE"></span><span id="_CPPv2N5arrow7compute12RoundOptions7ndigitsE"></span><span id="arrow::compute::RoundOptions::ndigits__int64_t"></span><span class="target" id="classarrow_1_1compute_1_1_round_options_1ac97411c4cb1514234959cd3c09736f85"></span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ndigits</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute12RoundOptions7ndigitsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Rounding precision (number of digits to round to) </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute12RoundOptions10round_modeE"> |
| <span id="_CPPv3N5arrow7compute12RoundOptions10round_modeE"></span><span id="_CPPv2N5arrow7compute12RoundOptions10round_modeE"></span><span id="arrow::compute::RoundOptions::round_mode__RoundMode"></span><span class="target" id="classarrow_1_1compute_1_1_round_options_1a54889733215222518832ec884961e808"></span><a class="reference internal" href="#_CPPv49RoundMode" title="RoundMode"><span class="n"><span class="pre">RoundMode</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">round_mode</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute12RoundOptions10round_modeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Rounding and tie-breaking mode. </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="_CPPv4N5arrow7compute12RoundOptions8DefaultsEv"> |
| <span id="_CPPv3N5arrow7compute12RoundOptions8DefaultsEv"></span><span id="_CPPv2N5arrow7compute12RoundOptions8DefaultsEv"></span><span id="arrow::compute::RoundOptions::Defaults"></span><span class="target" id="classarrow_1_1compute_1_1_round_options_1a35c69c432eb31f45e98a3e59a2f420cd"></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="#_CPPv4N5arrow7compute12RoundOptionsE" title="arrow::compute::RoundOptions"><span class="n"><span class="pre">RoundOptions</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="#_CPPv4N5arrow7compute12RoundOptions8DefaultsEv" 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-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute12RoundOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute12RoundOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute12RoundOptions9kTypeNameE"></span><span id="arrow::compute::RoundOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_round_options_1a66a201c794f7611ee850687243d74304"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"RoundOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute12RoundOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute18RoundBinaryOptionsE"> |
| <span id="_CPPv3N5arrow7compute18RoundBinaryOptionsE"></span><span id="_CPPv2N5arrow7compute18RoundBinaryOptionsE"></span><span id="arrow::compute::RoundBinaryOptions"></span><span class="target" id="classarrow_1_1compute_1_1_round_binary_options"></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">RoundBinaryOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute18RoundBinaryOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_scalar.h></em></div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute18RoundBinaryOptions18RoundBinaryOptionsE9RoundMode"> |
| <span id="_CPPv3N5arrow7compute18RoundBinaryOptions18RoundBinaryOptionsE9RoundMode"></span><span id="_CPPv2N5arrow7compute18RoundBinaryOptions18RoundBinaryOptionsE9RoundMode"></span><span id="arrow::compute::RoundBinaryOptions::RoundBinaryOptions__RoundMode"></span><span class="target" id="classarrow_1_1compute_1_1_round_binary_options_1a557ab524bd5ae4043a8f2fd565bac90b"></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">RoundBinaryOptions</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv49RoundMode" title="RoundMode"><span class="n"><span class="pre">RoundMode</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">round_mode</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv49RoundMode" title="RoundMode"><span class="n"><span class="pre">RoundMode</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N9RoundMode12HALF_TO_EVENE" title="RoundMode::HALF_TO_EVEN"><span class="n"><span class="pre">HALF_TO_EVEN</span></span></a><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute18RoundBinaryOptions18RoundBinaryOptionsE9RoundMode" 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="_CPPv4N5arrow7compute18RoundBinaryOptions10round_modeE"> |
| <span id="_CPPv3N5arrow7compute18RoundBinaryOptions10round_modeE"></span><span id="_CPPv2N5arrow7compute18RoundBinaryOptions10round_modeE"></span><span id="arrow::compute::RoundBinaryOptions::round_mode__RoundMode"></span><span class="target" id="classarrow_1_1compute_1_1_round_binary_options_1a7aae5a4ba7bc6cd04066c723211ab51e"></span><a class="reference internal" href="#_CPPv49RoundMode" title="RoundMode"><span class="n"><span class="pre">RoundMode</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">round_mode</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute18RoundBinaryOptions10round_modeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Rounding and tie-breaking mode. </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="_CPPv4N5arrow7compute18RoundBinaryOptions8DefaultsEv"> |
| <span id="_CPPv3N5arrow7compute18RoundBinaryOptions8DefaultsEv"></span><span id="_CPPv2N5arrow7compute18RoundBinaryOptions8DefaultsEv"></span><span id="arrow::compute::RoundBinaryOptions::Defaults"></span><span class="target" id="classarrow_1_1compute_1_1_round_binary_options_1af1b81f864e7b91f0cb953af2e538cc11"></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="#_CPPv4N5arrow7compute18RoundBinaryOptionsE" title="arrow::compute::RoundBinaryOptions"><span class="n"><span class="pre">RoundBinaryOptions</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="#_CPPv4N5arrow7compute18RoundBinaryOptions8DefaultsEv" 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-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute18RoundBinaryOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute18RoundBinaryOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute18RoundBinaryOptions9kTypeNameE"></span><span id="arrow::compute::RoundBinaryOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_round_binary_options_1a6b81383a22d90a76fff3bc2beef95572"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"RoundBinaryOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute18RoundBinaryOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute20RoundTemporalOptionsE"> |
| <span id="_CPPv3N5arrow7compute20RoundTemporalOptionsE"></span><span id="_CPPv2N5arrow7compute20RoundTemporalOptionsE"></span><span id="arrow::compute::RoundTemporalOptions"></span><span class="target" id="classarrow_1_1compute_1_1_round_temporal_options"></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">RoundTemporalOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute20RoundTemporalOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_scalar.h></em></div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute20RoundTemporalOptions20RoundTemporalOptionsEi12CalendarUnitbbb"> |
| <span id="_CPPv3N5arrow7compute20RoundTemporalOptions20RoundTemporalOptionsEi12CalendarUnitbbb"></span><span id="_CPPv2N5arrow7compute20RoundTemporalOptions20RoundTemporalOptionsEi12CalendarUnitbbb"></span><span id="arrow::compute::RoundTemporalOptions::RoundTemporalOptions__i.CalendarUnit.b.b.b"></span><span class="target" id="classarrow_1_1compute_1_1_round_temporal_options_1aac263c5ca563837125cdbcc1c5271314"></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">RoundTemporalOptions</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">multiple</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">1</span></span>, <a class="reference internal" href="#_CPPv412CalendarUnit" title="CalendarUnit"><span class="n"><span class="pre">CalendarUnit</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">unit</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv412CalendarUnit" title="CalendarUnit"><span class="n"><span class="pre">CalendarUnit</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N12CalendarUnit3DAYE" title="CalendarUnit::DAY"><span class="n"><span class="pre">DAY</span></span></a>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">week_starts_monday</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="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">ceil_is_strictly_greater</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="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">calendar_based_origin</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="#_CPPv4N5arrow7compute20RoundTemporalOptions20RoundTemporalOptionsEi12CalendarUnitbbb" 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="_CPPv4N5arrow7compute20RoundTemporalOptions8multipleE"> |
| <span id="_CPPv3N5arrow7compute20RoundTemporalOptions8multipleE"></span><span id="_CPPv2N5arrow7compute20RoundTemporalOptions8multipleE"></span><span id="arrow::compute::RoundTemporalOptions::multiple__i"></span><span class="target" id="classarrow_1_1compute_1_1_round_temporal_options_1a9ac277a43580193e4b9292f15dd10e4a"></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">multiple</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute20RoundTemporalOptions8multipleE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Number of units to round to. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute20RoundTemporalOptions4unitE"> |
| <span id="_CPPv3N5arrow7compute20RoundTemporalOptions4unitE"></span><span id="_CPPv2N5arrow7compute20RoundTemporalOptions4unitE"></span><span id="arrow::compute::RoundTemporalOptions::unit__CalendarUnit"></span><span class="target" id="classarrow_1_1compute_1_1_round_temporal_options_1a08cf3428cdaa5dbcc1aa8e2ad41327c1"></span><a class="reference internal" href="#_CPPv412CalendarUnit" title="CalendarUnit"><span class="n"><span class="pre">CalendarUnit</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">unit</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute20RoundTemporalOptions4unitE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The unit used for rounding of time. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute20RoundTemporalOptions18week_starts_mondayE"> |
| <span id="_CPPv3N5arrow7compute20RoundTemporalOptions18week_starts_mondayE"></span><span id="_CPPv2N5arrow7compute20RoundTemporalOptions18week_starts_mondayE"></span><span id="arrow::compute::RoundTemporalOptions::week_starts_monday__b"></span><span class="target" id="classarrow_1_1compute_1_1_round_temporal_options_1ac8a9a2cc4ca610beb76524ebdce85bcc"></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">week_starts_monday</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute20RoundTemporalOptions18week_starts_mondayE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>What day does the week start with (Monday=true, Sunday=false) </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute20RoundTemporalOptions24ceil_is_strictly_greaterE"> |
| <span id="_CPPv3N5arrow7compute20RoundTemporalOptions24ceil_is_strictly_greaterE"></span><span id="_CPPv2N5arrow7compute20RoundTemporalOptions24ceil_is_strictly_greaterE"></span><span id="arrow::compute::RoundTemporalOptions::ceil_is_strictly_greater__b"></span><span class="target" id="classarrow_1_1compute_1_1_round_temporal_options_1ab304179619e0dbcc7af8946093c78577"></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">ceil_is_strictly_greater</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute20RoundTemporalOptions24ceil_is_strictly_greaterE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Enable this flag to return a rounded value that is strictly greater than the input. </p> |
| <p>For example: ceiling 1970-01-01T00:00:00 to 3 hours would yield 1970-01-01T03:00:00 if set to true and 1970-01-01T00:00:00 if set to false. This applies for ceiling only. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute20RoundTemporalOptions21calendar_based_originE"> |
| <span id="_CPPv3N5arrow7compute20RoundTemporalOptions21calendar_based_originE"></span><span id="_CPPv2N5arrow7compute20RoundTemporalOptions21calendar_based_originE"></span><span id="arrow::compute::RoundTemporalOptions::calendar_based_origin__b"></span><span class="target" id="classarrow_1_1compute_1_1_round_temporal_options_1a06568a506e36c40364a64868fd38b77e"></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">calendar_based_origin</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute20RoundTemporalOptions21calendar_based_originE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>By default time is rounded to a multiple of units since 1970-01-01T00:00:00. </p> |
| <p>By setting calendar_based_origin to true, time will be rounded to a number of units since the last greater calendar unit. For example: rounding to a multiple of days since the beginning of the month or to hours since the beginning of the day. Exceptions: week and quarter are not used as greater units, therefore days will will be rounded to the beginning of the month not week. Greater unit of week is year. Note that ceiling and rounding might change sorting order of an array near greater unit change. For example rounding YYYY-mm-dd 23:00:00 to 5 hours will ceil and round to YYYY-mm-dd+1 01:00:00 and floor to YYYY-mm-dd 20:00:00. On the other hand YYYY-mm-dd+1 00:00:00 will ceil, round and floor to YYYY-mm-dd+1 00:00:00. This can break the order of an already ordered array. </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="_CPPv4N5arrow7compute20RoundTemporalOptions8DefaultsEv"> |
| <span id="_CPPv3N5arrow7compute20RoundTemporalOptions8DefaultsEv"></span><span id="_CPPv2N5arrow7compute20RoundTemporalOptions8DefaultsEv"></span><span id="arrow::compute::RoundTemporalOptions::Defaults"></span><span class="target" id="classarrow_1_1compute_1_1_round_temporal_options_1a5c9ddaaa2c0750b7985d6a6ad3d451f0"></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="#_CPPv4N5arrow7compute20RoundTemporalOptionsE" title="arrow::compute::RoundTemporalOptions"><span class="n"><span class="pre">RoundTemporalOptions</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="#_CPPv4N5arrow7compute20RoundTemporalOptions8DefaultsEv" 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-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute20RoundTemporalOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute20RoundTemporalOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute20RoundTemporalOptions9kTypeNameE"></span><span id="arrow::compute::RoundTemporalOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_round_temporal_options_1a9e75391541156de9a55d7704103021ab"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"RoundTemporalOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute20RoundTemporalOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute22RoundToMultipleOptionsE"> |
| <span id="_CPPv3N5arrow7compute22RoundToMultipleOptionsE"></span><span id="_CPPv2N5arrow7compute22RoundToMultipleOptionsE"></span><span id="arrow::compute::RoundToMultipleOptions"></span><span class="target" id="classarrow_1_1compute_1_1_round_to_multiple_options"></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">RoundToMultipleOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute22RoundToMultipleOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_scalar.h></em></div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute22RoundToMultipleOptions22RoundToMultipleOptionsEd9RoundMode"> |
| <span id="_CPPv3N5arrow7compute22RoundToMultipleOptions22RoundToMultipleOptionsEd9RoundMode"></span><span id="_CPPv2N5arrow7compute22RoundToMultipleOptions22RoundToMultipleOptionsEd9RoundMode"></span><span id="arrow::compute::RoundToMultipleOptions::RoundToMultipleOptions__double.RoundMode"></span><span class="target" id="classarrow_1_1compute_1_1_round_to_multiple_options_1a36aea1f751da66e48c044ac1a40ce932"></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">RoundToMultipleOptions</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">double</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">multiple</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">1.0</span></span>, <a class="reference internal" href="#_CPPv49RoundMode" title="RoundMode"><span class="n"><span class="pre">RoundMode</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">round_mode</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv49RoundMode" title="RoundMode"><span class="n"><span class="pre">RoundMode</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N9RoundMode12HALF_TO_EVENE" title="RoundMode::HALF_TO_EVEN"><span class="n"><span class="pre">HALF_TO_EVEN</span></span></a><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute22RoundToMultipleOptions22RoundToMultipleOptionsEd9RoundMode" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute22RoundToMultipleOptions22RoundToMultipleOptionsENSt10shared_ptrI6ScalarEE9RoundMode"> |
| <span id="_CPPv3N5arrow7compute22RoundToMultipleOptions22RoundToMultipleOptionsENSt10shared_ptrI6ScalarEE9RoundMode"></span><span id="_CPPv2N5arrow7compute22RoundToMultipleOptions22RoundToMultipleOptionsENSt10shared_ptrI6ScalarEE9RoundMode"></span><span id="arrow::compute::RoundToMultipleOptions::RoundToMultipleOptions__std::shared_ptr:Scalar:.RoundMode"></span><span class="target" id="classarrow_1_1compute_1_1_round_to_multiple_options_1a1061c45b7ce49d988396b6f7e1c7f937"></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">RoundToMultipleOptions</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="scalar.html#_CPPv4N5arrow6ScalarE" title="arrow::Scalar"><span class="n"><span class="pre">Scalar</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">multiple</span></span>, <a class="reference internal" href="#_CPPv49RoundMode" title="RoundMode"><span class="n"><span class="pre">RoundMode</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">round_mode</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv49RoundMode" title="RoundMode"><span class="n"><span class="pre">RoundMode</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N9RoundMode12HALF_TO_EVENE" title="RoundMode::HALF_TO_EVEN"><span class="n"><span class="pre">HALF_TO_EVEN</span></span></a><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute22RoundToMultipleOptions22RoundToMultipleOptionsENSt10shared_ptrI6ScalarEE9RoundMode" 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="_CPPv4N5arrow7compute22RoundToMultipleOptions8multipleE"> |
| <span id="_CPPv3N5arrow7compute22RoundToMultipleOptions8multipleE"></span><span id="_CPPv2N5arrow7compute22RoundToMultipleOptions8multipleE"></span><span id="arrow::compute::RoundToMultipleOptions::multiple__std::shared_ptr:Scalar:"></span><span class="target" id="classarrow_1_1compute_1_1_round_to_multiple_options_1a8efac0273067b22538219df069d690bf"></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="scalar.html#_CPPv4N5arrow6ScalarE" title="arrow::Scalar"><span class="n"><span class="pre">Scalar</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">multiple</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute22RoundToMultipleOptions8multipleE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Rounding scale (multiple to round to). </p> |
| <p>Should be a positive numeric scalar of a type compatible with the argument to be rounded. The cast kernel is used to convert the rounding multiple to match the result type. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute22RoundToMultipleOptions10round_modeE"> |
| <span id="_CPPv3N5arrow7compute22RoundToMultipleOptions10round_modeE"></span><span id="_CPPv2N5arrow7compute22RoundToMultipleOptions10round_modeE"></span><span id="arrow::compute::RoundToMultipleOptions::round_mode__RoundMode"></span><span class="target" id="classarrow_1_1compute_1_1_round_to_multiple_options_1a7a106505d8ac3cf9d3545fc04c35fa01"></span><a class="reference internal" href="#_CPPv49RoundMode" title="RoundMode"><span class="n"><span class="pre">RoundMode</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">round_mode</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute22RoundToMultipleOptions10round_modeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Rounding and tie-breaking mode. </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="_CPPv4N5arrow7compute22RoundToMultipleOptions8DefaultsEv"> |
| <span id="_CPPv3N5arrow7compute22RoundToMultipleOptions8DefaultsEv"></span><span id="_CPPv2N5arrow7compute22RoundToMultipleOptions8DefaultsEv"></span><span id="arrow::compute::RoundToMultipleOptions::Defaults"></span><span class="target" id="classarrow_1_1compute_1_1_round_to_multiple_options_1a2d8957f15b52f9865140ceff71653c13"></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="#_CPPv4N5arrow7compute22RoundToMultipleOptionsE" title="arrow::compute::RoundToMultipleOptions"><span class="n"><span class="pre">RoundToMultipleOptions</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="#_CPPv4N5arrow7compute22RoundToMultipleOptions8DefaultsEv" 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-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute22RoundToMultipleOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute22RoundToMultipleOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute22RoundToMultipleOptions9kTypeNameE"></span><span id="arrow::compute::RoundToMultipleOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_round_to_multiple_options_1a9957f20246788a5102ff37376e6a2990"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"RoundToMultipleOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute22RoundToMultipleOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11JoinOptionsE"> |
| <span id="_CPPv3N5arrow7compute11JoinOptionsE"></span><span id="_CPPv2N5arrow7compute11JoinOptionsE"></span><span id="arrow::compute::JoinOptions"></span><span class="target" id="classarrow_1_1compute_1_1_join_options"></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">JoinOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute11JoinOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_scalar.h></em></div> |
| <p>Options for var_args_join. </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 enum"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11JoinOptions20NullHandlingBehaviorE"> |
| <span id="_CPPv3N5arrow7compute11JoinOptions20NullHandlingBehaviorE"></span><span id="_CPPv2N5arrow7compute11JoinOptions20NullHandlingBehaviorE"></span><span class="target" id="classarrow_1_1compute_1_1_join_options_1a482dc1ead87472e29c32cf6a1a54ac7a"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">NullHandlingBehavior</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11JoinOptions20NullHandlingBehaviorE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>How to handle null values. (A null separator always results in a null output.) </p> |
| <p><em>Values:</em></p> |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11JoinOptions20NullHandlingBehavior9EMIT_NULLE"> |
| <span id="_CPPv3N5arrow7compute11JoinOptions20NullHandlingBehavior9EMIT_NULLE"></span><span id="_CPPv2N5arrow7compute11JoinOptions20NullHandlingBehavior9EMIT_NULLE"></span><span class="target" id="classarrow_1_1compute_1_1_join_options_1a482dc1ead87472e29c32cf6a1a54ac7aadc977be8937e69091ef51895ba98482d"></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">EMIT_NULL</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11JoinOptions20NullHandlingBehavior9EMIT_NULLE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A null in any input results in a null in the output. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11JoinOptions20NullHandlingBehavior4SKIPE"> |
| <span id="_CPPv3N5arrow7compute11JoinOptions20NullHandlingBehavior4SKIPE"></span><span id="_CPPv2N5arrow7compute11JoinOptions20NullHandlingBehavior4SKIPE"></span><span class="target" id="classarrow_1_1compute_1_1_join_options_1a482dc1ead87472e29c32cf6a1a54ac7aac6a2fcbd924cd8fe43eef4f9fe2790f7"></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">SKIP</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11JoinOptions20NullHandlingBehavior4SKIPE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Nulls in inputs are skipped. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11JoinOptions20NullHandlingBehavior7REPLACEE"> |
| <span id="_CPPv3N5arrow7compute11JoinOptions20NullHandlingBehavior7REPLACEE"></span><span id="_CPPv2N5arrow7compute11JoinOptions20NullHandlingBehavior7REPLACEE"></span><span class="target" id="classarrow_1_1compute_1_1_join_options_1a482dc1ead87472e29c32cf6a1a54ac7aa8f4f5714841c7580cff0b0ffd832aa8a"></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">REPLACE</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11JoinOptions20NullHandlingBehavior7REPLACEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Nulls in inputs are replaced with the replacement string. </p> |
| </dd></dl> |
| |
| </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="_CPPv4N5arrow7compute11JoinOptions11JoinOptionsE20NullHandlingBehaviorNSt6stringE"> |
| <span id="_CPPv3N5arrow7compute11JoinOptions11JoinOptionsE20NullHandlingBehaviorNSt6stringE"></span><span id="_CPPv2N5arrow7compute11JoinOptions11JoinOptionsE20NullHandlingBehaviorNSt6stringE"></span><span id="arrow::compute::JoinOptions::JoinOptions__NullHandlingBehavior.ss"></span><span class="target" id="classarrow_1_1compute_1_1_join_options_1a90d45fedf8a0f1322068d542e2bb3799"></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">JoinOptions</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4N5arrow7compute11JoinOptions20NullHandlingBehaviorE" title="arrow::compute::JoinOptions::NullHandlingBehavior"><span class="n"><span class="pre">NullHandlingBehavior</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">null_handling</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow7compute11JoinOptions20NullHandlingBehavior9EMIT_NULLE" title="arrow::compute::JoinOptions::EMIT_NULL"><span class="n"><span class="pre">EMIT_NULL</span></span></a>, <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">null_replacement</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">""</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute11JoinOptions11JoinOptionsE20NullHandlingBehaviorNSt6stringE" 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="_CPPv4N5arrow7compute11JoinOptions13null_handlingE"> |
| <span id="_CPPv3N5arrow7compute11JoinOptions13null_handlingE"></span><span id="_CPPv2N5arrow7compute11JoinOptions13null_handlingE"></span><span id="arrow::compute::JoinOptions::null_handling__NullHandlingBehavior"></span><span class="target" id="classarrow_1_1compute_1_1_join_options_1ac4077a98b49bd31c791915d6d39d9b62"></span><a class="reference internal" href="#_CPPv4N5arrow7compute11JoinOptions20NullHandlingBehaviorE" title="arrow::compute::JoinOptions::NullHandlingBehavior"><span class="n"><span class="pre">NullHandlingBehavior</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">null_handling</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11JoinOptions13null_handlingE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11JoinOptions16null_replacementE"> |
| <span id="_CPPv3N5arrow7compute11JoinOptions16null_replacementE"></span><span id="_CPPv2N5arrow7compute11JoinOptions16null_replacementE"></span><span id="arrow::compute::JoinOptions::null_replacement__ss"></span><span class="target" id="classarrow_1_1compute_1_1_join_options_1a9e7fc30f72fc50fde22c37f7278e6116"></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">null_replacement</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11JoinOptions16null_replacementE" 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="_CPPv4N5arrow7compute11JoinOptions8DefaultsEv"> |
| <span id="_CPPv3N5arrow7compute11JoinOptions8DefaultsEv"></span><span id="_CPPv2N5arrow7compute11JoinOptions8DefaultsEv"></span><span id="arrow::compute::JoinOptions::Defaults"></span><span class="target" id="classarrow_1_1compute_1_1_join_options_1ad7c9bad9227c03c311fe1b3d7f3ced34"></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="#_CPPv4N5arrow7compute11JoinOptionsE" title="arrow::compute::JoinOptions"><span class="n"><span class="pre">JoinOptions</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="#_CPPv4N5arrow7compute11JoinOptions8DefaultsEv" 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-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11JoinOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute11JoinOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute11JoinOptions9kTypeNameE"></span><span id="arrow::compute::JoinOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_join_options_1a6c0c12d8615ab85718d41aa8d4a90809"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"JoinOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11JoinOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute21MatchSubstringOptionsE"> |
| <span id="_CPPv3N5arrow7compute21MatchSubstringOptionsE"></span><span id="_CPPv2N5arrow7compute21MatchSubstringOptionsE"></span><span id="arrow::compute::MatchSubstringOptions"></span><span class="target" id="classarrow_1_1compute_1_1_match_substring_options"></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">MatchSubstringOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute21MatchSubstringOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_scalar.h></em></div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute21MatchSubstringOptions21MatchSubstringOptionsENSt6stringEb"> |
| <span id="_CPPv3N5arrow7compute21MatchSubstringOptions21MatchSubstringOptionsENSt6stringEb"></span><span id="_CPPv2N5arrow7compute21MatchSubstringOptions21MatchSubstringOptionsENSt6stringEb"></span><span id="arrow::compute::MatchSubstringOptions::MatchSubstringOptions__ss.b"></span><span class="target" id="classarrow_1_1compute_1_1_match_substring_options_1a63613816e1e53c1c37678d28c9cd058d"></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">MatchSubstringOptions</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">pattern</span></span>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">ignore_case</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="#_CPPv4N5arrow7compute21MatchSubstringOptions21MatchSubstringOptionsENSt6stringEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute21MatchSubstringOptions21MatchSubstringOptionsEv"> |
| <span id="_CPPv3N5arrow7compute21MatchSubstringOptions21MatchSubstringOptionsEv"></span><span id="_CPPv2N5arrow7compute21MatchSubstringOptions21MatchSubstringOptionsEv"></span><span id="arrow::compute::MatchSubstringOptions::MatchSubstringOptions"></span><span class="target" id="classarrow_1_1compute_1_1_match_substring_options_1a7a25aecb3f123ba69d361210a210f851"></span><span class="sig-name descname"><span class="n"><span class="pre">MatchSubstringOptions</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute21MatchSubstringOptions21MatchSubstringOptionsEv" 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="_CPPv4N5arrow7compute21MatchSubstringOptions7patternE"> |
| <span id="_CPPv3N5arrow7compute21MatchSubstringOptions7patternE"></span><span id="_CPPv2N5arrow7compute21MatchSubstringOptions7patternE"></span><span id="arrow::compute::MatchSubstringOptions::pattern__ss"></span><span class="target" id="classarrow_1_1compute_1_1_match_substring_options_1a27af404877a2e526dae132dbb9f37863"></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">pattern</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute21MatchSubstringOptions7patternE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The exact substring (or regex, depending on kernel) to look for inside input values. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute21MatchSubstringOptions11ignore_caseE"> |
| <span id="_CPPv3N5arrow7compute21MatchSubstringOptions11ignore_caseE"></span><span id="_CPPv2N5arrow7compute21MatchSubstringOptions11ignore_caseE"></span><span id="arrow::compute::MatchSubstringOptions::ignore_case__b"></span><span class="target" id="classarrow_1_1compute_1_1_match_substring_options_1a67796c1881d09782a2e6639c7e5bad6c"></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">ignore_case</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute21MatchSubstringOptions11ignore_caseE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Whether to perform a case-insensitive match. </p> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-static-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute21MatchSubstringOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute21MatchSubstringOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute21MatchSubstringOptions9kTypeNameE"></span><span id="arrow::compute::MatchSubstringOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_match_substring_options_1a8371bbd1eb02fd83a19ed88820b31e2c"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"MatchSubstringOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute21MatchSubstringOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute12SplitOptionsE"> |
| <span id="_CPPv3N5arrow7compute12SplitOptionsE"></span><span id="_CPPv2N5arrow7compute12SplitOptionsE"></span><span id="arrow::compute::SplitOptions"></span><span class="target" id="classarrow_1_1compute_1_1_split_options"></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">SplitOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute12SplitOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_scalar.h></em></div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute12SplitOptions12SplitOptionsE7int64_tb"> |
| <span id="_CPPv3N5arrow7compute12SplitOptions12SplitOptionsE7int64_tb"></span><span id="_CPPv2N5arrow7compute12SplitOptions12SplitOptionsE7int64_tb"></span><span id="arrow::compute::SplitOptions::SplitOptions__int64_t.b"></span><span class="target" id="classarrow_1_1compute_1_1_split_options_1a50a41fad50d967f55ab61756115a425a"></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">SplitOptions</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">max_splits</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="o"><span class="pre">-</span></span><span class="m"><span class="pre">1</span></span>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">reverse</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="#_CPPv4N5arrow7compute12SplitOptions12SplitOptionsE7int64_tb" 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="_CPPv4N5arrow7compute12SplitOptions10max_splitsE"> |
| <span id="_CPPv3N5arrow7compute12SplitOptions10max_splitsE"></span><span id="_CPPv2N5arrow7compute12SplitOptions10max_splitsE"></span><span id="arrow::compute::SplitOptions::max_splits__int64_t"></span><span class="target" id="classarrow_1_1compute_1_1_split_options_1a5faefb325fc732df2629e0ef30a1c847"></span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">max_splits</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute12SplitOptions10max_splitsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Maximum number of splits allowed, or unlimited when -1. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute12SplitOptions7reverseE"> |
| <span id="_CPPv3N5arrow7compute12SplitOptions7reverseE"></span><span id="_CPPv2N5arrow7compute12SplitOptions7reverseE"></span><span id="arrow::compute::SplitOptions::reverse__b"></span><span class="target" id="classarrow_1_1compute_1_1_split_options_1ab9c9088b7440ebb2d5fcc0767cebec82"></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">reverse</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute12SplitOptions7reverseE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Start splitting from the end of the string (only relevant when max_splits != -1) </p> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-static-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute12SplitOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute12SplitOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute12SplitOptions9kTypeNameE"></span><span id="arrow::compute::SplitOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_split_options_1aae6585a76e1165b0410a0f1eb4e74884"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"SplitOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute12SplitOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute19SplitPatternOptionsE"> |
| <span id="_CPPv3N5arrow7compute19SplitPatternOptionsE"></span><span id="_CPPv2N5arrow7compute19SplitPatternOptionsE"></span><span id="arrow::compute::SplitPatternOptions"></span><span class="target" id="classarrow_1_1compute_1_1_split_pattern_options"></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">SplitPatternOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute19SplitPatternOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_scalar.h></em></div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute19SplitPatternOptions19SplitPatternOptionsENSt6stringE7int64_tb"> |
| <span id="_CPPv3N5arrow7compute19SplitPatternOptions19SplitPatternOptionsENSt6stringE7int64_tb"></span><span id="_CPPv2N5arrow7compute19SplitPatternOptions19SplitPatternOptionsENSt6stringE7int64_tb"></span><span id="arrow::compute::SplitPatternOptions::SplitPatternOptions__ss.int64_t.b"></span><span class="target" id="classarrow_1_1compute_1_1_split_pattern_options_1a2c115d467fcfbcf5bf0f1522f011650d"></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">SplitPatternOptions</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">pattern</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">max_splits</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="o"><span class="pre">-</span></span><span class="m"><span class="pre">1</span></span>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">reverse</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="#_CPPv4N5arrow7compute19SplitPatternOptions19SplitPatternOptionsENSt6stringE7int64_tb" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute19SplitPatternOptions19SplitPatternOptionsEv"> |
| <span id="_CPPv3N5arrow7compute19SplitPatternOptions19SplitPatternOptionsEv"></span><span id="_CPPv2N5arrow7compute19SplitPatternOptions19SplitPatternOptionsEv"></span><span id="arrow::compute::SplitPatternOptions::SplitPatternOptions"></span><span class="target" id="classarrow_1_1compute_1_1_split_pattern_options_1a6192d4beba13d0ad0278fb471c6a07de"></span><span class="sig-name descname"><span class="n"><span class="pre">SplitPatternOptions</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute19SplitPatternOptions19SplitPatternOptionsEv" 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="_CPPv4N5arrow7compute19SplitPatternOptions7patternE"> |
| <span id="_CPPv3N5arrow7compute19SplitPatternOptions7patternE"></span><span id="_CPPv2N5arrow7compute19SplitPatternOptions7patternE"></span><span id="arrow::compute::SplitPatternOptions::pattern__ss"></span><span class="target" id="classarrow_1_1compute_1_1_split_pattern_options_1a9d48859574987709584b1f8dbdc398c7"></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">pattern</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute19SplitPatternOptions7patternE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The exact substring to split on. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute19SplitPatternOptions10max_splitsE"> |
| <span id="_CPPv3N5arrow7compute19SplitPatternOptions10max_splitsE"></span><span id="_CPPv2N5arrow7compute19SplitPatternOptions10max_splitsE"></span><span id="arrow::compute::SplitPatternOptions::max_splits__int64_t"></span><span class="target" id="classarrow_1_1compute_1_1_split_pattern_options_1a3892d723eb6228fbc7ad61e44a23d172"></span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">max_splits</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute19SplitPatternOptions10max_splitsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Maximum number of splits allowed, or unlimited when -1. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute19SplitPatternOptions7reverseE"> |
| <span id="_CPPv3N5arrow7compute19SplitPatternOptions7reverseE"></span><span id="_CPPv2N5arrow7compute19SplitPatternOptions7reverseE"></span><span id="arrow::compute::SplitPatternOptions::reverse__b"></span><span class="target" id="classarrow_1_1compute_1_1_split_pattern_options_1a25c63d7f760cf3ca4d643503f3aaa199"></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">reverse</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute19SplitPatternOptions7reverseE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Start splitting from the end of the string (only relevant when max_splits != -1) </p> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-static-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute19SplitPatternOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute19SplitPatternOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute19SplitPatternOptions9kTypeNameE"></span><span id="arrow::compute::SplitPatternOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_split_pattern_options_1a16c7554bce04196c630cfb370f4a2055"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"SplitPatternOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute19SplitPatternOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute19ReplaceSliceOptionsE"> |
| <span id="_CPPv3N5arrow7compute19ReplaceSliceOptionsE"></span><span id="_CPPv2N5arrow7compute19ReplaceSliceOptionsE"></span><span id="arrow::compute::ReplaceSliceOptions"></span><span class="target" id="classarrow_1_1compute_1_1_replace_slice_options"></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">ReplaceSliceOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute19ReplaceSliceOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_scalar.h></em></div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute19ReplaceSliceOptions19ReplaceSliceOptionsE7int64_t7int64_tNSt6stringE"> |
| <span id="_CPPv3N5arrow7compute19ReplaceSliceOptions19ReplaceSliceOptionsE7int64_t7int64_tNSt6stringE"></span><span id="_CPPv2N5arrow7compute19ReplaceSliceOptions19ReplaceSliceOptionsE7int64_t7int64_tNSt6stringE"></span><span id="arrow::compute::ReplaceSliceOptions::ReplaceSliceOptions__int64_t.int64_t.ss"></span><span class="target" id="classarrow_1_1compute_1_1_replace_slice_options_1a781c44cf07c65cfa1fbe00ee92e11347"></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">ReplaceSliceOptions</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">start</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">stop</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="w"> </span><span class="n sig-param"><span class="pre">replacement</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute19ReplaceSliceOptions19ReplaceSliceOptionsE7int64_t7int64_tNSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute19ReplaceSliceOptions19ReplaceSliceOptionsEv"> |
| <span id="_CPPv3N5arrow7compute19ReplaceSliceOptions19ReplaceSliceOptionsEv"></span><span id="_CPPv2N5arrow7compute19ReplaceSliceOptions19ReplaceSliceOptionsEv"></span><span id="arrow::compute::ReplaceSliceOptions::ReplaceSliceOptions"></span><span class="target" id="classarrow_1_1compute_1_1_replace_slice_options_1a3b4444bed17fd42b740282a87e31a00b"></span><span class="sig-name descname"><span class="n"><span class="pre">ReplaceSliceOptions</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute19ReplaceSliceOptions19ReplaceSliceOptionsEv" 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="_CPPv4N5arrow7compute19ReplaceSliceOptions5startE"> |
| <span id="_CPPv3N5arrow7compute19ReplaceSliceOptions5startE"></span><span id="_CPPv2N5arrow7compute19ReplaceSliceOptions5startE"></span><span id="arrow::compute::ReplaceSliceOptions::start__int64_t"></span><span class="target" id="classarrow_1_1compute_1_1_replace_slice_options_1a9eba6f1e32a9349d34e95db47a6b5da7"></span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">start</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute19ReplaceSliceOptions5startE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Index to start slicing at. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute19ReplaceSliceOptions4stopE"> |
| <span id="_CPPv3N5arrow7compute19ReplaceSliceOptions4stopE"></span><span id="_CPPv2N5arrow7compute19ReplaceSliceOptions4stopE"></span><span id="arrow::compute::ReplaceSliceOptions::stop__int64_t"></span><span class="target" id="classarrow_1_1compute_1_1_replace_slice_options_1a172c789796297b07791ac4fd89fa32a2"></span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">stop</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute19ReplaceSliceOptions4stopE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Index to stop slicing at. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute19ReplaceSliceOptions11replacementE"> |
| <span id="_CPPv3N5arrow7compute19ReplaceSliceOptions11replacementE"></span><span id="_CPPv2N5arrow7compute19ReplaceSliceOptions11replacementE"></span><span id="arrow::compute::ReplaceSliceOptions::replacement__ss"></span><span class="target" id="classarrow_1_1compute_1_1_replace_slice_options_1a58e3b3370d33c44efd9b7283fc45edf1"></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">replacement</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute19ReplaceSliceOptions11replacementE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>String to replace the slice with. </p> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-static-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute19ReplaceSliceOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute19ReplaceSliceOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute19ReplaceSliceOptions9kTypeNameE"></span><span id="arrow::compute::ReplaceSliceOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_replace_slice_options_1a06952bfda512f97a5a3730fcec462f5e"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"ReplaceSliceOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute19ReplaceSliceOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute23ReplaceSubstringOptionsE"> |
| <span id="_CPPv3N5arrow7compute23ReplaceSubstringOptionsE"></span><span id="_CPPv2N5arrow7compute23ReplaceSubstringOptionsE"></span><span id="arrow::compute::ReplaceSubstringOptions"></span><span class="target" id="classarrow_1_1compute_1_1_replace_substring_options"></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">ReplaceSubstringOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute23ReplaceSubstringOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_scalar.h></em></div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute23ReplaceSubstringOptions23ReplaceSubstringOptionsENSt6stringENSt6stringE7int64_t"> |
| <span id="_CPPv3N5arrow7compute23ReplaceSubstringOptions23ReplaceSubstringOptionsENSt6stringENSt6stringE7int64_t"></span><span id="_CPPv2N5arrow7compute23ReplaceSubstringOptions23ReplaceSubstringOptionsENSt6stringENSt6stringE7int64_t"></span><span id="arrow::compute::ReplaceSubstringOptions::ReplaceSubstringOptions__ss.ss.int64_t"></span><span class="target" id="classarrow_1_1compute_1_1_replace_substring_options_1a209fdc230b728257c6efce87cc97748c"></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">ReplaceSubstringOptions</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">pattern</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="w"> </span><span class="n sig-param"><span class="pre">replacement</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">max_replacements</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="o"><span class="pre">-</span></span><span class="m"><span class="pre">1</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute23ReplaceSubstringOptions23ReplaceSubstringOptionsENSt6stringENSt6stringE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute23ReplaceSubstringOptions23ReplaceSubstringOptionsEv"> |
| <span id="_CPPv3N5arrow7compute23ReplaceSubstringOptions23ReplaceSubstringOptionsEv"></span><span id="_CPPv2N5arrow7compute23ReplaceSubstringOptions23ReplaceSubstringOptionsEv"></span><span id="arrow::compute::ReplaceSubstringOptions::ReplaceSubstringOptions"></span><span class="target" id="classarrow_1_1compute_1_1_replace_substring_options_1a99a9b10fd46fe0dd21a1f5f0b861da38"></span><span class="sig-name descname"><span class="n"><span class="pre">ReplaceSubstringOptions</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute23ReplaceSubstringOptions23ReplaceSubstringOptionsEv" 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="_CPPv4N5arrow7compute23ReplaceSubstringOptions7patternE"> |
| <span id="_CPPv3N5arrow7compute23ReplaceSubstringOptions7patternE"></span><span id="_CPPv2N5arrow7compute23ReplaceSubstringOptions7patternE"></span><span id="arrow::compute::ReplaceSubstringOptions::pattern__ss"></span><span class="target" id="classarrow_1_1compute_1_1_replace_substring_options_1a1063ba11c6c584f2f5a36e31fb411361"></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">pattern</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute23ReplaceSubstringOptions7patternE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Pattern to match, literal, or regular expression depending on which kernel is used. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute23ReplaceSubstringOptions11replacementE"> |
| <span id="_CPPv3N5arrow7compute23ReplaceSubstringOptions11replacementE"></span><span id="_CPPv2N5arrow7compute23ReplaceSubstringOptions11replacementE"></span><span id="arrow::compute::ReplaceSubstringOptions::replacement__ss"></span><span class="target" id="classarrow_1_1compute_1_1_replace_substring_options_1a2fc1a87e8b2bba388b314619003e4e79"></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">replacement</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute23ReplaceSubstringOptions11replacementE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>String to replace the pattern with. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute23ReplaceSubstringOptions16max_replacementsE"> |
| <span id="_CPPv3N5arrow7compute23ReplaceSubstringOptions16max_replacementsE"></span><span id="_CPPv2N5arrow7compute23ReplaceSubstringOptions16max_replacementsE"></span><span id="arrow::compute::ReplaceSubstringOptions::max_replacements__int64_t"></span><span class="target" id="classarrow_1_1compute_1_1_replace_substring_options_1ac57f336134ed99cd41ca5b4a33990f7c"></span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">max_replacements</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute23ReplaceSubstringOptions16max_replacementsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Max number of substrings to replace (-1 means unbounded) </p> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-static-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute23ReplaceSubstringOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute23ReplaceSubstringOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute23ReplaceSubstringOptions9kTypeNameE"></span><span id="arrow::compute::ReplaceSubstringOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_replace_substring_options_1a9c58a4fd6a23652a4f9642497d17206b"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"ReplaceSubstringOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute23ReplaceSubstringOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute19ExtractRegexOptionsE"> |
| <span id="_CPPv3N5arrow7compute19ExtractRegexOptionsE"></span><span id="_CPPv2N5arrow7compute19ExtractRegexOptionsE"></span><span id="arrow::compute::ExtractRegexOptions"></span><span class="target" id="classarrow_1_1compute_1_1_extract_regex_options"></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">ExtractRegexOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute19ExtractRegexOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_scalar.h></em></div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute19ExtractRegexOptions19ExtractRegexOptionsENSt6stringE"> |
| <span id="_CPPv3N5arrow7compute19ExtractRegexOptions19ExtractRegexOptionsENSt6stringE"></span><span id="_CPPv2N5arrow7compute19ExtractRegexOptions19ExtractRegexOptionsENSt6stringE"></span><span id="arrow::compute::ExtractRegexOptions::ExtractRegexOptions__ss"></span><span class="target" id="classarrow_1_1compute_1_1_extract_regex_options_1a2d09073e8802d6f2c2607d73af00c81e"></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">ExtractRegexOptions</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">pattern</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute19ExtractRegexOptions19ExtractRegexOptionsENSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute19ExtractRegexOptions19ExtractRegexOptionsEv"> |
| <span id="_CPPv3N5arrow7compute19ExtractRegexOptions19ExtractRegexOptionsEv"></span><span id="_CPPv2N5arrow7compute19ExtractRegexOptions19ExtractRegexOptionsEv"></span><span id="arrow::compute::ExtractRegexOptions::ExtractRegexOptions"></span><span class="target" id="classarrow_1_1compute_1_1_extract_regex_options_1a5c01e301bede5fc69994ec14c186a266"></span><span class="sig-name descname"><span class="n"><span class="pre">ExtractRegexOptions</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute19ExtractRegexOptions19ExtractRegexOptionsEv" 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="_CPPv4N5arrow7compute19ExtractRegexOptions7patternE"> |
| <span id="_CPPv3N5arrow7compute19ExtractRegexOptions7patternE"></span><span id="_CPPv2N5arrow7compute19ExtractRegexOptions7patternE"></span><span id="arrow::compute::ExtractRegexOptions::pattern__ss"></span><span class="target" id="classarrow_1_1compute_1_1_extract_regex_options_1ac944cc3371e108ab85199c4081fae2ce"></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">pattern</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute19ExtractRegexOptions7patternE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Regular expression with named capture fields. </p> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-static-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute19ExtractRegexOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute19ExtractRegexOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute19ExtractRegexOptions9kTypeNameE"></span><span id="arrow::compute::ExtractRegexOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_extract_regex_options_1adca20d3c5a39afd8a9ed5e0485fde98c"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"ExtractRegexOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute19ExtractRegexOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16SetLookupOptionsE"> |
| <span id="_CPPv3N5arrow7compute16SetLookupOptionsE"></span><span id="_CPPv2N5arrow7compute16SetLookupOptionsE"></span><span id="arrow::compute::SetLookupOptions"></span><span class="target" id="classarrow_1_1compute_1_1_set_lookup_options"></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">SetLookupOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute16SetLookupOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_scalar.h></em></div> |
| <p>Options for IsIn and IndexIn functions. </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 enum"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16SetLookupOptions20NullMatchingBehaviorE"> |
| <span id="_CPPv3N5arrow7compute16SetLookupOptions20NullMatchingBehaviorE"></span><span id="_CPPv2N5arrow7compute16SetLookupOptions20NullMatchingBehaviorE"></span><span class="target" id="classarrow_1_1compute_1_1_set_lookup_options_1a32842c607f9d782b9c6f92ab2c8f1892"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">NullMatchingBehavior</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute16SetLookupOptions20NullMatchingBehaviorE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>How to handle null values. </p> |
| <p><em>Values:</em></p> |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16SetLookupOptions20NullMatchingBehavior5MATCHE"> |
| <span id="_CPPv3N5arrow7compute16SetLookupOptions20NullMatchingBehavior5MATCHE"></span><span id="_CPPv2N5arrow7compute16SetLookupOptions20NullMatchingBehavior5MATCHE"></span><span class="target" id="classarrow_1_1compute_1_1_set_lookup_options_1a32842c607f9d782b9c6f92ab2c8f1892aac11056d4b42a662dc3fd05523a49603"></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">MATCH</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute16SetLookupOptions20NullMatchingBehavior5MATCHE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>MATCH, any null in <code class="docutils literal notranslate"><span class="pre">value_set</span></code> is successfully matched in the input. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16SetLookupOptions20NullMatchingBehavior4SKIPE"> |
| <span id="_CPPv3N5arrow7compute16SetLookupOptions20NullMatchingBehavior4SKIPE"></span><span id="_CPPv2N5arrow7compute16SetLookupOptions20NullMatchingBehavior4SKIPE"></span><span class="target" id="classarrow_1_1compute_1_1_set_lookup_options_1a32842c607f9d782b9c6f92ab2c8f1892acffec87836571319bab6f035ef938fb4"></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">SKIP</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute16SetLookupOptions20NullMatchingBehavior4SKIPE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>SKIP, any null in <code class="docutils literal notranslate"><span class="pre">value_set</span></code> is ignored and nulls in the input produce null (IndexIn) or false (IsIn) values in the output. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16SetLookupOptions20NullMatchingBehavior9EMIT_NULLE"> |
| <span id="_CPPv3N5arrow7compute16SetLookupOptions20NullMatchingBehavior9EMIT_NULLE"></span><span id="_CPPv2N5arrow7compute16SetLookupOptions20NullMatchingBehavior9EMIT_NULLE"></span><span class="target" id="classarrow_1_1compute_1_1_set_lookup_options_1a32842c607f9d782b9c6f92ab2c8f1892a633556fba6550595224b7eae93611216"></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">EMIT_NULL</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute16SetLookupOptions20NullMatchingBehavior9EMIT_NULLE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>EMIT_NULL, any null in <code class="docutils literal notranslate"><span class="pre">value_set</span></code> is ignored and nulls in the input produce null (IndexIn and IsIn) values in the output. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16SetLookupOptions20NullMatchingBehavior12INCONCLUSIVEE"> |
| <span id="_CPPv3N5arrow7compute16SetLookupOptions20NullMatchingBehavior12INCONCLUSIVEE"></span><span id="_CPPv2N5arrow7compute16SetLookupOptions20NullMatchingBehavior12INCONCLUSIVEE"></span><span class="target" id="classarrow_1_1compute_1_1_set_lookup_options_1a32842c607f9d782b9c6f92ab2c8f1892a55c07df15773c7379aaa355368b2a634"></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">INCONCLUSIVE</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute16SetLookupOptions20NullMatchingBehavior12INCONCLUSIVEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>INCONCLUSIVE, null values are regarded as unknown values, which is sql-compatible. </p> |
| <p>nulls in the input produce null (IndexIn and IsIn) values in the output. Besides, if <code class="docutils literal notranslate"><span class="pre">value_set</span></code> contains a null, non-null unmatched values in the input also produce null values (IndexIn and IsIn) in the output. </p> |
| </dd></dl> |
| |
| </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="_CPPv4N5arrow7compute16SetLookupOptions16SetLookupOptionsE5Datum20NullMatchingBehavior"> |
| <span id="_CPPv3N5arrow7compute16SetLookupOptions16SetLookupOptionsE5Datum20NullMatchingBehavior"></span><span id="_CPPv2N5arrow7compute16SetLookupOptions16SetLookupOptionsE5Datum20NullMatchingBehavior"></span><span id="arrow::compute::SetLookupOptions::SetLookupOptions__Datum.NullMatchingBehavior"></span><span class="target" id="classarrow_1_1compute_1_1_set_lookup_options_1a4a2f3be835bfde25053f6800ce141919"></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">SetLookupOptions</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4N5arrow5DatumE" title="arrow::Datum"><span class="n"><span class="pre">Datum</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">value_set</span></span>, <a class="reference internal" href="#_CPPv4N5arrow7compute16SetLookupOptions20NullMatchingBehaviorE" title="arrow::compute::SetLookupOptions::NullMatchingBehavior"><span class="n"><span class="pre">NullMatchingBehavior</span></span></a><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow7compute16SetLookupOptions20NullMatchingBehavior5MATCHE" title="arrow::compute::SetLookupOptions::MATCH"><span class="n"><span class="pre">MATCH</span></span></a><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute16SetLookupOptions16SetLookupOptionsE5Datum20NullMatchingBehavior" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16SetLookupOptions16SetLookupOptionsEv"> |
| <span id="_CPPv3N5arrow7compute16SetLookupOptions16SetLookupOptionsEv"></span><span id="_CPPv2N5arrow7compute16SetLookupOptions16SetLookupOptionsEv"></span><span id="arrow::compute::SetLookupOptions::SetLookupOptions"></span><span class="target" id="classarrow_1_1compute_1_1_set_lookup_options_1a3ce8ad3456eef145659ae23bad117d57"></span><span class="sig-name descname"><span class="n"><span class="pre">SetLookupOptions</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute16SetLookupOptions16SetLookupOptionsEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16SetLookupOptions16SetLookupOptionsE5Datumb"> |
| <span id="_CPPv3N5arrow7compute16SetLookupOptions16SetLookupOptionsE5Datumb"></span><span id="_CPPv2N5arrow7compute16SetLookupOptions16SetLookupOptionsE5Datumb"></span><span id="arrow::compute::SetLookupOptions::SetLookupOptions__Datum.b"></span><span class="target" id="classarrow_1_1compute_1_1_set_lookup_options_1a81dae03630566379d3158162c0ee9330"></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">SetLookupOptions</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4N5arrow5DatumE" title="arrow::Datum"><span class="n"><span class="pre">Datum</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">value_set</span></span>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">skip_nulls</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute16SetLookupOptions16SetLookupOptionsE5Datumb" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow7compute16SetLookupOptions23GetNullMatchingBehaviorEv"> |
| <span id="_CPPv3NK5arrow7compute16SetLookupOptions23GetNullMatchingBehaviorEv"></span><span id="_CPPv2NK5arrow7compute16SetLookupOptions23GetNullMatchingBehaviorEv"></span><span id="arrow::compute::SetLookupOptions::GetNullMatchingBehaviorC"></span><span class="target" id="classarrow_1_1compute_1_1_set_lookup_options_1aa4848716e7224cca25863b7f62152a04"></span><a class="reference internal" href="#_CPPv4N5arrow7compute16SetLookupOptions20NullMatchingBehaviorE" title="arrow::compute::SetLookupOptions::NullMatchingBehavior"><span class="n"><span class="pre">NullMatchingBehavior</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetNullMatchingBehavior</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="#_CPPv4NK5arrow7compute16SetLookupOptions23GetNullMatchingBehaviorEv" 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="_CPPv4N5arrow7compute16SetLookupOptions9value_setE"> |
| <span id="_CPPv3N5arrow7compute16SetLookupOptions9value_setE"></span><span id="_CPPv2N5arrow7compute16SetLookupOptions9value_setE"></span><span id="arrow::compute::SetLookupOptions::value_set__Datum"></span><span class="target" id="classarrow_1_1compute_1_1_set_lookup_options_1a17175b84e177cfba080c9c2694113f06"></span><a class="reference internal" href="#_CPPv4N5arrow5DatumE" title="arrow::Datum"><span class="n"><span class="pre">Datum</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">value_set</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute16SetLookupOptions9value_setE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The set of values to look up input values into. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16SetLookupOptions22null_matching_behaviorE"> |
| <span id="_CPPv3N5arrow7compute16SetLookupOptions22null_matching_behaviorE"></span><span id="_CPPv2N5arrow7compute16SetLookupOptions22null_matching_behaviorE"></span><span id="arrow::compute::SetLookupOptions::null_matching_behavior__NullMatchingBehavior"></span><span class="target" id="classarrow_1_1compute_1_1_set_lookup_options_1aa18997164a49df4af0cef5aab17443eb"></span><a class="reference internal" href="#_CPPv4N5arrow7compute16SetLookupOptions20NullMatchingBehaviorE" title="arrow::compute::SetLookupOptions::NullMatchingBehavior"><span class="n"><span class="pre">NullMatchingBehavior</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">null_matching_behavior</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute16SetLookupOptions22null_matching_behaviorE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16SetLookupOptions10skip_nullsE"> |
| <span id="_CPPv3N5arrow7compute16SetLookupOptions10skip_nullsE"></span><span id="_CPPv2N5arrow7compute16SetLookupOptions10skip_nullsE"></span><span id="arrow::compute::SetLookupOptions::skip_nulls__std::optional:b:"></span><span class="target" id="classarrow_1_1compute_1_1_set_lookup_options_1abcd5030694c0dfedcd033f4576827521"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre"><</span></span><span class="kt"><span class="pre">bool</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">skip_nulls</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute16SetLookupOptions10skip_nullsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Whether nulls in <code class="docutils literal notranslate"><span class="pre">value_set</span></code> count for lookup. </p> |
| <p>If true, any null in <code class="docutils literal notranslate"><span class="pre">value_set</span></code> is ignored and nulls in the input produce null (IndexIn) or false (IsIn) values in the output. If false, any null in <code class="docutils literal notranslate"><span class="pre">value_set</span></code> is successfully matched in the input. </p> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-static-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16SetLookupOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute16SetLookupOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute16SetLookupOptions9kTypeNameE"></span><span id="arrow::compute::SetLookupOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_set_lookup_options_1a109dc90c03adff088744c1462a3d81f1"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"SetLookupOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute16SetLookupOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute18StructFieldOptionsE"> |
| <span id="_CPPv3N5arrow7compute18StructFieldOptionsE"></span><span id="_CPPv2N5arrow7compute18StructFieldOptionsE"></span><span id="arrow::compute::StructFieldOptions"></span><span class="target" id="classarrow_1_1compute_1_1_struct_field_options"></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">StructFieldOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute18StructFieldOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_scalar.h></em></div> |
| <p>Options for struct_field function. </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="_CPPv4N5arrow7compute18StructFieldOptions18StructFieldOptionsENSt6vectorIiEE"> |
| <span id="_CPPv3N5arrow7compute18StructFieldOptions18StructFieldOptionsENSt6vectorIiEE"></span><span id="_CPPv2N5arrow7compute18StructFieldOptions18StructFieldOptionsENSt6vectorIiEE"></span><span id="arrow::compute::StructFieldOptions::StructFieldOptions__std::vector:i:"></span><span class="target" id="classarrow_1_1compute_1_1_struct_field_options_1a33fb87c51c350ff1b0e59c8f2fc95cb7"></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">StructFieldOptions</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="#_CPPv4N5arrow7compute18StructFieldOptions18StructFieldOptionsENSt6vectorIiEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute18StructFieldOptions18StructFieldOptionsENSt16initializer_listIiEE"> |
| <span id="_CPPv3N5arrow7compute18StructFieldOptions18StructFieldOptionsENSt16initializer_listIiEE"></span><span id="_CPPv2N5arrow7compute18StructFieldOptions18StructFieldOptionsENSt16initializer_listIiEE"></span><span id="arrow::compute::StructFieldOptions::StructFieldOptions__std::initializer_list:i:"></span><span class="target" id="classarrow_1_1compute_1_1_struct_field_options_1a45eda827364b266f6a2caaf58d778af6"></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">StructFieldOptions</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="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute18StructFieldOptions18StructFieldOptionsENSt16initializer_listIiEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute18StructFieldOptions18StructFieldOptionsE8FieldRef"> |
| <span id="_CPPv3N5arrow7compute18StructFieldOptions18StructFieldOptionsE8FieldRef"></span><span id="_CPPv2N5arrow7compute18StructFieldOptions18StructFieldOptionsE8FieldRef"></span><span id="arrow::compute::StructFieldOptions::StructFieldOptions__FieldRef"></span><span class="target" id="classarrow_1_1compute_1_1_struct_field_options_1a6175ce62b64b2b391f173cf3983c7b62"></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">StructFieldOptions</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="datatype.html#_CPPv4N5arrow8FieldRefE" title="arrow::FieldRef"><span class="n"><span class="pre">FieldRef</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">field_ref</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute18StructFieldOptions18StructFieldOptionsE8FieldRef" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute18StructFieldOptions18StructFieldOptionsEv"> |
| <span id="_CPPv3N5arrow7compute18StructFieldOptions18StructFieldOptionsEv"></span><span id="_CPPv2N5arrow7compute18StructFieldOptions18StructFieldOptionsEv"></span><span id="arrow::compute::StructFieldOptions::StructFieldOptions"></span><span class="target" id="classarrow_1_1compute_1_1_struct_field_options_1afcb374e438654d41a1db06b1cac64686"></span><span class="sig-name descname"><span class="n"><span class="pre">StructFieldOptions</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute18StructFieldOptions18StructFieldOptionsEv" 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="_CPPv4N5arrow7compute18StructFieldOptions9field_refE"> |
| <span id="_CPPv3N5arrow7compute18StructFieldOptions9field_refE"></span><span id="_CPPv2N5arrow7compute18StructFieldOptions9field_refE"></span><span id="arrow::compute::StructFieldOptions::field_ref__FieldRef"></span><span class="target" id="classarrow_1_1compute_1_1_struct_field_options_1ada60699720fc8f22f8f437be9b2d03f0"></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow8FieldRefE" title="arrow::FieldRef"><span class="n"><span class="pre">FieldRef</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">field_ref</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute18StructFieldOptions9field_refE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The <a class="reference internal" href="datatype.html#classarrow_1_1_field_ref"><span class="std std-ref">FieldRef</span></a> specifying what to extract from struct or union. </p> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-static-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute18StructFieldOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute18StructFieldOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute18StructFieldOptions9kTypeNameE"></span><span id="arrow::compute::StructFieldOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_struct_field_options_1a671369805d9ee30e696351d5ae4c0290"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"StructFieldOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute18StructFieldOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute15StrptimeOptionsE"> |
| <span id="_CPPv3N5arrow7compute15StrptimeOptionsE"></span><span id="_CPPv2N5arrow7compute15StrptimeOptionsE"></span><span id="arrow::compute::StrptimeOptions"></span><span class="target" id="classarrow_1_1compute_1_1_strptime_options"></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">StrptimeOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute15StrptimeOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_scalar.h></em></div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute15StrptimeOptions15StrptimeOptionsENSt6stringEN8TimeUnit4typeEb"> |
| <span id="_CPPv3N5arrow7compute15StrptimeOptions15StrptimeOptionsENSt6stringEN8TimeUnit4typeEb"></span><span id="_CPPv2N5arrow7compute15StrptimeOptions15StrptimeOptionsENSt6stringEN8TimeUnit4typeEb"></span><span id="arrow::compute::StrptimeOptions::StrptimeOptions__ss.TimeUnit::type.b"></span><span class="target" id="classarrow_1_1compute_1_1_strptime_options_1af68693e02d7ae9130883dbf7e557bca7"></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">StrptimeOptions</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">format</span></span>, <span class="n"><span class="pre">TimeUnit</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow8TimeUnit4typeE" title="arrow::TimeUnit::type"><span class="n"><span class="pre">type</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">unit</span></span>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">error_is_null</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="#_CPPv4N5arrow7compute15StrptimeOptions15StrptimeOptionsENSt6stringEN8TimeUnit4typeEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute15StrptimeOptions15StrptimeOptionsEv"> |
| <span id="_CPPv3N5arrow7compute15StrptimeOptions15StrptimeOptionsEv"></span><span id="_CPPv2N5arrow7compute15StrptimeOptions15StrptimeOptionsEv"></span><span id="arrow::compute::StrptimeOptions::StrptimeOptions"></span><span class="target" id="classarrow_1_1compute_1_1_strptime_options_1a0d4e2a4be35f85884fbb736268849337"></span><span class="sig-name descname"><span class="n"><span class="pre">StrptimeOptions</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute15StrptimeOptions15StrptimeOptionsEv" 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="_CPPv4N5arrow7compute15StrptimeOptions6formatE"> |
| <span id="_CPPv3N5arrow7compute15StrptimeOptions6formatE"></span><span id="_CPPv2N5arrow7compute15StrptimeOptions6formatE"></span><span id="arrow::compute::StrptimeOptions::format__ss"></span><span class="target" id="classarrow_1_1compute_1_1_strptime_options_1a92697813c777760ce63ec7660a589957"></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">format</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute15StrptimeOptions6formatE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The desired format string. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute15StrptimeOptions4unitE"> |
| <span id="_CPPv3N5arrow7compute15StrptimeOptions4unitE"></span><span id="_CPPv2N5arrow7compute15StrptimeOptions4unitE"></span><span id="arrow::compute::StrptimeOptions::unit__TimeUnit::type"></span><span class="target" id="classarrow_1_1compute_1_1_strptime_options_1afeb1278f73dc4bc3fdbcb552f4843015"></span><span class="n"><span class="pre">TimeUnit</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow8TimeUnit4typeE" title="arrow::TimeUnit::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">unit</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute15StrptimeOptions4unitE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The desired time resolution. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute15StrptimeOptions13error_is_nullE"> |
| <span id="_CPPv3N5arrow7compute15StrptimeOptions13error_is_nullE"></span><span id="_CPPv2N5arrow7compute15StrptimeOptions13error_is_nullE"></span><span id="arrow::compute::StrptimeOptions::error_is_null__b"></span><span class="target" id="classarrow_1_1compute_1_1_strptime_options_1aaccdb88c1d639320a6080992c0991da9"></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">error_is_null</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute15StrptimeOptions13error_is_nullE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return null on parsing errors if true or raise if false. </p> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-static-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute15StrptimeOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute15StrptimeOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute15StrptimeOptions9kTypeNameE"></span><span id="arrow::compute::StrptimeOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_strptime_options_1a69b50168e085e5310254a2fc9830702d"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"StrptimeOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute15StrptimeOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute15StrftimeOptionsE"> |
| <span id="_CPPv3N5arrow7compute15StrftimeOptionsE"></span><span id="_CPPv2N5arrow7compute15StrftimeOptionsE"></span><span id="arrow::compute::StrftimeOptions"></span><span class="target" id="classarrow_1_1compute_1_1_strftime_options"></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">StrftimeOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute15StrftimeOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_scalar.h></em></div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute15StrftimeOptions15StrftimeOptionsENSt6stringENSt6stringE"> |
| <span id="_CPPv3N5arrow7compute15StrftimeOptions15StrftimeOptionsENSt6stringENSt6stringE"></span><span id="_CPPv2N5arrow7compute15StrftimeOptions15StrftimeOptionsENSt6stringENSt6stringE"></span><span id="arrow::compute::StrftimeOptions::StrftimeOptions__ss.ss"></span><span class="target" id="classarrow_1_1compute_1_1_strftime_options_1a2697012a77ae835b1dfdb9e50fa448f9"></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">StrftimeOptions</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">format</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="w"> </span><span class="n sig-param"><span class="pre">locale</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"C"</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute15StrftimeOptions15StrftimeOptionsENSt6stringENSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute15StrftimeOptions15StrftimeOptionsEv"> |
| <span id="_CPPv3N5arrow7compute15StrftimeOptions15StrftimeOptionsEv"></span><span id="_CPPv2N5arrow7compute15StrftimeOptions15StrftimeOptionsEv"></span><span id="arrow::compute::StrftimeOptions::StrftimeOptions"></span><span class="target" id="classarrow_1_1compute_1_1_strftime_options_1a987694a3d3d89b9e0a53e2bb9ed51d9a"></span><span class="sig-name descname"><span class="n"><span class="pre">StrftimeOptions</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute15StrftimeOptions15StrftimeOptionsEv" 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="_CPPv4N5arrow7compute15StrftimeOptions6formatE"> |
| <span id="_CPPv3N5arrow7compute15StrftimeOptions6formatE"></span><span id="_CPPv2N5arrow7compute15StrftimeOptions6formatE"></span><span id="arrow::compute::StrftimeOptions::format__ss"></span><span class="target" id="classarrow_1_1compute_1_1_strftime_options_1a12f4c3789f0712ec2b19696d34e3f92a"></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">format</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute15StrftimeOptions6formatE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The desired format string. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute15StrftimeOptions6localeE"> |
| <span id="_CPPv3N5arrow7compute15StrftimeOptions6localeE"></span><span id="_CPPv2N5arrow7compute15StrftimeOptions6localeE"></span><span id="arrow::compute::StrftimeOptions::locale__ss"></span><span class="target" id="classarrow_1_1compute_1_1_strftime_options_1a400b8242788d1e70fa3af4bd9a347419"></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">locale</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute15StrftimeOptions6localeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The desired output locale string. </p> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-static-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute15StrftimeOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute15StrftimeOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute15StrftimeOptions9kTypeNameE"></span><span id="arrow::compute::StrftimeOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_strftime_options_1aed089ba32beb482ccedfa72a6bf07724"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"StrftimeOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute15StrftimeOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute15StrftimeOptions14kDefaultFormatE"> |
| <span id="_CPPv3N5arrow7compute15StrftimeOptions14kDefaultFormatE"></span><span id="_CPPv2N5arrow7compute15StrftimeOptions14kDefaultFormatE"></span><span id="arrow::compute::StrftimeOptions::kDefaultFormat__cCP"></span><span class="target" id="classarrow_1_1compute_1_1_strftime_options_1ae76895ec7a0fb7b8cf856d731d19ed84"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </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="sig-name descname"><span class="n"><span class="pre">kDefaultFormat</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"%Y-%m-%dT%H:%M:%S"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute15StrftimeOptions14kDefaultFormatE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute10PadOptionsE"> |
| <span id="_CPPv3N5arrow7compute10PadOptionsE"></span><span id="_CPPv2N5arrow7compute10PadOptionsE"></span><span id="arrow::compute::PadOptions"></span><span class="target" id="classarrow_1_1compute_1_1_pad_options"></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">PadOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute10PadOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_scalar.h></em></div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute10PadOptions10PadOptionsE7int64_tNSt6stringE"> |
| <span id="_CPPv3N5arrow7compute10PadOptions10PadOptionsE7int64_tNSt6stringE"></span><span id="_CPPv2N5arrow7compute10PadOptions10PadOptionsE7int64_tNSt6stringE"></span><span id="arrow::compute::PadOptions::PadOptions__int64_t.ss"></span><span class="target" id="classarrow_1_1compute_1_1_pad_options_1a08afb1dde21c8ed8c66fdef0c729400b"></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">PadOptions</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">width</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="w"> </span><span class="n sig-param"><span class="pre">padding</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"</span> <span class="pre">"</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute10PadOptions10PadOptionsE7int64_tNSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute10PadOptions10PadOptionsEv"> |
| <span id="_CPPv3N5arrow7compute10PadOptions10PadOptionsEv"></span><span id="_CPPv2N5arrow7compute10PadOptions10PadOptionsEv"></span><span id="arrow::compute::PadOptions::PadOptions"></span><span class="target" id="classarrow_1_1compute_1_1_pad_options_1a8588273f84a300dba7d95bf756bc43b2"></span><span class="sig-name descname"><span class="n"><span class="pre">PadOptions</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute10PadOptions10PadOptionsEv" 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="_CPPv4N5arrow7compute10PadOptions5widthE"> |
| <span id="_CPPv3N5arrow7compute10PadOptions5widthE"></span><span id="_CPPv2N5arrow7compute10PadOptions5widthE"></span><span id="arrow::compute::PadOptions::width__int64_t"></span><span class="target" id="classarrow_1_1compute_1_1_pad_options_1ad8b95afc75e6534404c95f9246e8d67f"></span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">width</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute10PadOptions5widthE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The desired string length. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute10PadOptions7paddingE"> |
| <span id="_CPPv3N5arrow7compute10PadOptions7paddingE"></span><span id="_CPPv2N5arrow7compute10PadOptions7paddingE"></span><span id="arrow::compute::PadOptions::padding__ss"></span><span class="target" id="classarrow_1_1compute_1_1_pad_options_1a2e678f2158f73eb053c1ec234f7d721c"></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">padding</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute10PadOptions7paddingE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>What to pad the string with. Should be one codepoint (Unicode)/byte (ASCII). </p> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-static-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute10PadOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute10PadOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute10PadOptions9kTypeNameE"></span><span id="arrow::compute::PadOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_pad_options_1a5a292f6a660894517fa38594b018ee65"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"PadOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute10PadOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11TrimOptionsE"> |
| <span id="_CPPv3N5arrow7compute11TrimOptionsE"></span><span id="_CPPv2N5arrow7compute11TrimOptionsE"></span><span id="arrow::compute::TrimOptions"></span><span class="target" id="classarrow_1_1compute_1_1_trim_options"></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">TrimOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute11TrimOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_scalar.h></em></div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11TrimOptions11TrimOptionsENSt6stringE"> |
| <span id="_CPPv3N5arrow7compute11TrimOptions11TrimOptionsENSt6stringE"></span><span id="_CPPv2N5arrow7compute11TrimOptions11TrimOptionsENSt6stringE"></span><span id="arrow::compute::TrimOptions::TrimOptions__ss"></span><span class="target" id="classarrow_1_1compute_1_1_trim_options_1a09e5f74cbeb57de563d8ef96172c86dd"></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">TrimOptions</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">characters</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute11TrimOptions11TrimOptionsENSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11TrimOptions11TrimOptionsEv"> |
| <span id="_CPPv3N5arrow7compute11TrimOptions11TrimOptionsEv"></span><span id="_CPPv2N5arrow7compute11TrimOptions11TrimOptionsEv"></span><span id="arrow::compute::TrimOptions::TrimOptions"></span><span class="target" id="classarrow_1_1compute_1_1_trim_options_1a8460d5810fd11a6149872c7a20609960"></span><span class="sig-name descname"><span class="n"><span class="pre">TrimOptions</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute11TrimOptions11TrimOptionsEv" 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="_CPPv4N5arrow7compute11TrimOptions10charactersE"> |
| <span id="_CPPv3N5arrow7compute11TrimOptions10charactersE"></span><span id="_CPPv2N5arrow7compute11TrimOptions10charactersE"></span><span id="arrow::compute::TrimOptions::characters__ss"></span><span class="target" id="classarrow_1_1compute_1_1_trim_options_1ab107b183414b10ffa451d93693019a13"></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">characters</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11TrimOptions10charactersE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The individual characters to be trimmed from the string. </p> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-static-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11TrimOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute11TrimOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute11TrimOptions9kTypeNameE"></span><span id="arrow::compute::TrimOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_trim_options_1ae0ab7bbfe61c5f90d3f54641d80ebd28"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"TrimOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11TrimOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute12SliceOptionsE"> |
| <span id="_CPPv3N5arrow7compute12SliceOptionsE"></span><span id="_CPPv2N5arrow7compute12SliceOptionsE"></span><span id="arrow::compute::SliceOptions"></span><span class="target" id="classarrow_1_1compute_1_1_slice_options"></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">SliceOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute12SliceOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_scalar.h></em></div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute12SliceOptions12SliceOptionsE7int64_t7int64_t7int64_t"> |
| <span id="_CPPv3N5arrow7compute12SliceOptions12SliceOptionsE7int64_t7int64_t7int64_t"></span><span id="_CPPv2N5arrow7compute12SliceOptions12SliceOptionsE7int64_t7int64_t7int64_t"></span><span id="arrow::compute::SliceOptions::SliceOptions__int64_t.int64_t.int64_t"></span><span class="target" id="classarrow_1_1compute_1_1_slice_options_1a72b4bd1e719cb5d7621bc541b071b457"></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">SliceOptions</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">start</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">stop</span></span><span class="w"> </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">numeric_limits</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">int64_t</span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">max</span></span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">)</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">step</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">1</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute12SliceOptions12SliceOptionsE7int64_t7int64_t7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute12SliceOptions12SliceOptionsEv"> |
| <span id="_CPPv3N5arrow7compute12SliceOptions12SliceOptionsEv"></span><span id="_CPPv2N5arrow7compute12SliceOptions12SliceOptionsEv"></span><span id="arrow::compute::SliceOptions::SliceOptions"></span><span class="target" id="classarrow_1_1compute_1_1_slice_options_1a760fe3c1e074be248f56045643ef858d"></span><span class="sig-name descname"><span class="n"><span class="pre">SliceOptions</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute12SliceOptions12SliceOptionsEv" 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="_CPPv4N5arrow7compute12SliceOptions5startE"> |
| <span id="_CPPv3N5arrow7compute12SliceOptions5startE"></span><span id="_CPPv2N5arrow7compute12SliceOptions5startE"></span><span id="arrow::compute::SliceOptions::start__int64_t"></span><span class="target" id="classarrow_1_1compute_1_1_slice_options_1afae00ce9e6a4e7bfd318278c1370b0d5"></span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">start</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute12SliceOptions5startE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute12SliceOptions4stopE"> |
| <span id="_CPPv3N5arrow7compute12SliceOptions4stopE"></span><span id="_CPPv2N5arrow7compute12SliceOptions4stopE"></span><span id="arrow::compute::SliceOptions::stop__int64_t"></span><span class="target" id="classarrow_1_1compute_1_1_slice_options_1abcdada17c2572c38b8425a45ad750a8f"></span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">stop</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute12SliceOptions4stopE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute12SliceOptions4stepE"> |
| <span id="_CPPv3N5arrow7compute12SliceOptions4stepE"></span><span id="_CPPv2N5arrow7compute12SliceOptions4stepE"></span><span id="arrow::compute::SliceOptions::step__int64_t"></span><span class="target" id="classarrow_1_1compute_1_1_slice_options_1ae52b6397f4527a785689e247e58dbadf"></span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">step</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute12SliceOptions4stepE" 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-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute12SliceOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute12SliceOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute12SliceOptions9kTypeNameE"></span><span id="arrow::compute::SliceOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_slice_options_1a215deb83c735c15f8daf37d11c0e8340"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"SliceOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute12SliceOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16ListSliceOptionsE"> |
| <span id="_CPPv3N5arrow7compute16ListSliceOptionsE"></span><span id="_CPPv2N5arrow7compute16ListSliceOptionsE"></span><span id="arrow::compute::ListSliceOptions"></span><span class="target" id="classarrow_1_1compute_1_1_list_slice_options"></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">ListSliceOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute16ListSliceOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_scalar.h></em></div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16ListSliceOptions16ListSliceOptionsE7int64_tNSt8optionalI7int64_tEE7int64_tNSt8optionalIbEE"> |
| <span id="_CPPv3N5arrow7compute16ListSliceOptions16ListSliceOptionsE7int64_tNSt8optionalI7int64_tEE7int64_tNSt8optionalIbEE"></span><span id="_CPPv2N5arrow7compute16ListSliceOptions16ListSliceOptionsE7int64_tNSt8optionalI7int64_tEE7int64_tNSt8optionalIbEE"></span><span id="arrow::compute::ListSliceOptions::ListSliceOptions__int64_t.std::optional:int64_t:.int64_t.std::optional:b:"></span><span class="target" id="classarrow_1_1compute_1_1_list_slice_options_1a4f7133cd33cfe8292d7dee72757d8b84"></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">ListSliceOptions</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">start</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">optional</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">int64_t</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">stop</span></span><span class="w"> </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">nullopt</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">step</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">1</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">optional</span></span><span class="p"><span class="pre"><</span></span><span class="kt"><span class="pre">bool</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">return_fixed_size_list</span></span><span class="w"> </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">nullopt</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute16ListSliceOptions16ListSliceOptionsE7int64_tNSt8optionalI7int64_tEE7int64_tNSt8optionalIbEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16ListSliceOptions16ListSliceOptionsEv"> |
| <span id="_CPPv3N5arrow7compute16ListSliceOptions16ListSliceOptionsEv"></span><span id="_CPPv2N5arrow7compute16ListSliceOptions16ListSliceOptionsEv"></span><span id="arrow::compute::ListSliceOptions::ListSliceOptions"></span><span class="target" id="classarrow_1_1compute_1_1_list_slice_options_1a1e7a45a694ad4c9d0fbad06eea5528f1"></span><span class="sig-name descname"><span class="n"><span class="pre">ListSliceOptions</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute16ListSliceOptions16ListSliceOptionsEv" 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="_CPPv4N5arrow7compute16ListSliceOptions5startE"> |
| <span id="_CPPv3N5arrow7compute16ListSliceOptions5startE"></span><span id="_CPPv2N5arrow7compute16ListSliceOptions5startE"></span><span id="arrow::compute::ListSliceOptions::start__int64_t"></span><span class="target" id="classarrow_1_1compute_1_1_list_slice_options_1a7b60a09974b916ff98260c349f975c67"></span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">start</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute16ListSliceOptions5startE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The start of list slicing. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16ListSliceOptions4stopE"> |
| <span id="_CPPv3N5arrow7compute16ListSliceOptions4stopE"></span><span id="_CPPv2N5arrow7compute16ListSliceOptions4stopE"></span><span id="arrow::compute::ListSliceOptions::stop__std::optional:int64_t:"></span><span class="target" id="classarrow_1_1compute_1_1_list_slice_options_1aba9f50d612b0781b8a283f8f5a10fb9e"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">int64_t</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">stop</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute16ListSliceOptions4stopE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Optional stop of list slicing. If not set, then slice to end. (NotImplemented) </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16ListSliceOptions4stepE"> |
| <span id="_CPPv3N5arrow7compute16ListSliceOptions4stepE"></span><span id="_CPPv2N5arrow7compute16ListSliceOptions4stepE"></span><span id="arrow::compute::ListSliceOptions::step__int64_t"></span><span class="target" id="classarrow_1_1compute_1_1_list_slice_options_1a580773c7a1a20ca5334877781a96ffc0"></span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">step</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute16ListSliceOptions4stepE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Slicing step. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16ListSliceOptions22return_fixed_size_listE"> |
| <span id="_CPPv3N5arrow7compute16ListSliceOptions22return_fixed_size_listE"></span><span id="_CPPv2N5arrow7compute16ListSliceOptions22return_fixed_size_listE"></span><span id="arrow::compute::ListSliceOptions::return_fixed_size_list__std::optional:b:"></span><span class="target" id="classarrow_1_1compute_1_1_list_slice_options_1ac201101a9de276a97ed7aefe6f112cf0"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre"><</span></span><span class="kt"><span class="pre">bool</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">return_fixed_size_list</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute16ListSliceOptions22return_fixed_size_listE" 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-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16ListSliceOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute16ListSliceOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute16ListSliceOptions9kTypeNameE"></span><span id="arrow::compute::ListSliceOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_list_slice_options_1a92716dfe43f45114544c413de12e5b8c"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"ListSliceOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute16ListSliceOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11NullOptionsE"> |
| <span id="_CPPv3N5arrow7compute11NullOptionsE"></span><span id="_CPPv2N5arrow7compute11NullOptionsE"></span><span id="arrow::compute::NullOptions"></span><span class="target" id="classarrow_1_1compute_1_1_null_options"></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">NullOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute11NullOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_scalar.h></em></div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11NullOptions11NullOptionsEb"> |
| <span id="_CPPv3N5arrow7compute11NullOptions11NullOptionsEb"></span><span id="_CPPv2N5arrow7compute11NullOptions11NullOptionsEb"></span><span id="arrow::compute::NullOptions::NullOptions__b"></span><span class="target" id="classarrow_1_1compute_1_1_null_options_1a1666491b66f23655894b6dffaf5a4bda"></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">NullOptions</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">nan_is_null</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="#_CPPv4N5arrow7compute11NullOptions11NullOptionsEb" 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="_CPPv4N5arrow7compute11NullOptions11nan_is_nullE"> |
| <span id="_CPPv3N5arrow7compute11NullOptions11nan_is_nullE"></span><span id="_CPPv2N5arrow7compute11NullOptions11nan_is_nullE"></span><span id="arrow::compute::NullOptions::nan_is_null__b"></span><span class="target" id="classarrow_1_1compute_1_1_null_options_1a42a25f20a4360caad1d504ee6d1a4ae6"></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">nan_is_null</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11NullOptions11nan_is_nullE" 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="_CPPv4N5arrow7compute11NullOptions8DefaultsEv"> |
| <span id="_CPPv3N5arrow7compute11NullOptions8DefaultsEv"></span><span id="_CPPv2N5arrow7compute11NullOptions8DefaultsEv"></span><span id="arrow::compute::NullOptions::Defaults"></span><span class="target" id="classarrow_1_1compute_1_1_null_options_1ac1e418bc0f4e7e888a37d919f16222b9"></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="#_CPPv4N5arrow7compute11NullOptionsE" title="arrow::compute::NullOptions"><span class="n"><span class="pre">NullOptions</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="#_CPPv4N5arrow7compute11NullOptions8DefaultsEv" 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-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11NullOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute11NullOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute11NullOptions9kTypeNameE"></span><span id="arrow::compute::NullOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_null_options_1a2e35b9dc7031aa43565bd6be978fbf7b"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"NullOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11NullOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute14CompareOptionsE"> |
| <span id="_CPPv3N5arrow7compute14CompareOptionsE"></span><span id="_CPPv2N5arrow7compute14CompareOptionsE"></span><span id="arrow::compute::CompareOptions"></span><span class="target" id="structarrow_1_1compute_1_1_compare_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">CompareOptions</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute14CompareOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_scalar.h></em></div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute14CompareOptions14CompareOptionsE15CompareOperator"> |
| <span id="_CPPv3N5arrow7compute14CompareOptions14CompareOptionsE15CompareOperator"></span><span id="_CPPv2N5arrow7compute14CompareOptions14CompareOptionsE15CompareOperator"></span><span id="arrow::compute::CompareOptions::CompareOptions__CompareOperator"></span><span class="target" id="structarrow_1_1compute_1_1_compare_options_1ada9e1139107e948125021a4387ccd07c"></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">CompareOptions</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv415CompareOperator" title="CompareOperator"><span class="n"><span class="pre">CompareOperator</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">op</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute14CompareOptions14CompareOptionsE15CompareOperator" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute14CompareOptions14CompareOptionsEv"> |
| <span id="_CPPv3N5arrow7compute14CompareOptions14CompareOptionsEv"></span><span id="_CPPv2N5arrow7compute14CompareOptions14CompareOptionsEv"></span><span id="arrow::compute::CompareOptions::CompareOptions"></span><span class="target" id="structarrow_1_1compute_1_1_compare_options_1abcaa43f535b85c23e8993b69d2440cbe"></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">CompareOptions</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute14CompareOptions14CompareOptionsEv" 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="_CPPv4N5arrow7compute14CompareOptions2opE"> |
| <span id="_CPPv3N5arrow7compute14CompareOptions2opE"></span><span id="_CPPv2N5arrow7compute14CompareOptions2opE"></span><span id="arrow::compute::CompareOptions::op__CompareOperator"></span><span class="target" id="structarrow_1_1compute_1_1_compare_options_1a6aeca93a8f67c2f0644debc7c3ab53cf"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv415CompareOperator" title="CompareOperator"><span class="n"><span class="pre">CompareOperator</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">op</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute14CompareOptions2opE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute17MakeStructOptionsE"> |
| <span id="_CPPv3N5arrow7compute17MakeStructOptionsE"></span><span id="_CPPv2N5arrow7compute17MakeStructOptionsE"></span><span id="arrow::compute::MakeStructOptions"></span><span class="target" id="classarrow_1_1compute_1_1_make_struct_options"></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">MakeStructOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute17MakeStructOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_scalar.h></em></div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute17MakeStructOptions17MakeStructOptionsENSt6vectorINSt6stringEEENSt6vectorIbEENSt6vectorINSt10shared_ptrIK16KeyValueMetadataEEEE"> |
| <span id="_CPPv3N5arrow7compute17MakeStructOptions17MakeStructOptionsENSt6vectorINSt6stringEEENSt6vectorIbEENSt6vectorINSt10shared_ptrIK16KeyValueMetadataEEEE"></span><span id="_CPPv2N5arrow7compute17MakeStructOptions17MakeStructOptionsENSt6vectorINSt6stringEEENSt6vectorIbEENSt6vectorINSt10shared_ptrIK16KeyValueMetadataEEEE"></span><span id="arrow::compute::MakeStructOptions::MakeStructOptions__std::vector:ss:.std::vector:b:.std::vector:std::shared_ptr:KeyValueMetadataC::"></span><span class="target" id="classarrow_1_1compute_1_1_make_struct_options_1a43953894d8ec802c8b10b696e7bf7746"></span><span class="sig-name descname"><span class="n"><span class="pre">MakeStructOptions</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="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">n</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="kt"><span class="pre">bool</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">r</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="datatype.html#_CPPv4N5arrow16KeyValueMetadataE" title="arrow::KeyValueMetadata"><span class="n"><span class="pre">KeyValueMetadata</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">m</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute17MakeStructOptions17MakeStructOptionsENSt6vectorINSt6stringEEENSt6vectorIbEENSt6vectorINSt10shared_ptrIK16KeyValueMetadataEEEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute17MakeStructOptions17MakeStructOptionsENSt6vectorINSt6stringEEE"> |
| <span id="_CPPv3N5arrow7compute17MakeStructOptions17MakeStructOptionsENSt6vectorINSt6stringEEE"></span><span id="_CPPv2N5arrow7compute17MakeStructOptions17MakeStructOptionsENSt6vectorINSt6stringEEE"></span><span id="arrow::compute::MakeStructOptions::MakeStructOptions__std::vector:ss:"></span><span class="target" id="classarrow_1_1compute_1_1_make_struct_options_1ae99bfb833e20afa3fcb1f56a12a1d4e6"></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">MakeStructOptions</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="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">n</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute17MakeStructOptions17MakeStructOptionsENSt6vectorINSt6stringEEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute17MakeStructOptions17MakeStructOptionsEv"> |
| <span id="_CPPv3N5arrow7compute17MakeStructOptions17MakeStructOptionsEv"></span><span id="_CPPv2N5arrow7compute17MakeStructOptions17MakeStructOptionsEv"></span><span id="arrow::compute::MakeStructOptions::MakeStructOptions"></span><span class="target" id="classarrow_1_1compute_1_1_make_struct_options_1a5888a1354357161fc4364d875528c0eb"></span><span class="sig-name descname"><span class="n"><span class="pre">MakeStructOptions</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute17MakeStructOptions17MakeStructOptionsEv" 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="_CPPv4N5arrow7compute17MakeStructOptions11field_namesE"> |
| <span id="_CPPv3N5arrow7compute17MakeStructOptions11field_namesE"></span><span id="_CPPv2N5arrow7compute17MakeStructOptions11field_namesE"></span><span id="arrow::compute::MakeStructOptions::field_names__std::vector:ss:"></span><span class="target" id="classarrow_1_1compute_1_1_make_struct_options_1a6bed95f43651ae8fc231331f39e87d25"></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="sig-name descname"><span class="n"><span class="pre">field_names</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute17MakeStructOptions11field_namesE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Names for wrapped columns. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute17MakeStructOptions17field_nullabilityE"> |
| <span id="_CPPv3N5arrow7compute17MakeStructOptions17field_nullabilityE"></span><span id="_CPPv2N5arrow7compute17MakeStructOptions17field_nullabilityE"></span><span id="arrow::compute::MakeStructOptions::field_nullability__std::vector:b:"></span><span class="target" id="classarrow_1_1compute_1_1_make_struct_options_1a9552f24ba46d001b766a9c516990ebaa"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="kt"><span class="pre">bool</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">field_nullability</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute17MakeStructOptions17field_nullabilityE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Nullability bits for wrapped columns. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute17MakeStructOptions14field_metadataE"> |
| <span id="_CPPv3N5arrow7compute17MakeStructOptions14field_metadataE"></span><span id="_CPPv2N5arrow7compute17MakeStructOptions14field_metadataE"></span><span id="arrow::compute::MakeStructOptions::field_metadata__std::vector:std::shared_ptr:KeyValueMetadataC::"></span><span class="target" id="classarrow_1_1compute_1_1_make_struct_options_1aed91ac8a09fc46b8f4c307d688921cea"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="datatype.html#_CPPv4N5arrow16KeyValueMetadataE" title="arrow::KeyValueMetadata"><span class="n"><span class="pre">KeyValueMetadata</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">field_metadata</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute17MakeStructOptions14field_metadataE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Metadata attached to wrapped columns. </p> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-static-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute17MakeStructOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute17MakeStructOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute17MakeStructOptions9kTypeNameE"></span><span id="arrow::compute::MakeStructOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_make_struct_options_1acf399e86fa116ab020bbe3b9eb83121f"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"MakeStructOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute17MakeStructOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16DayOfWeekOptionsE"> |
| <span id="_CPPv3N5arrow7compute16DayOfWeekOptionsE"></span><span id="_CPPv2N5arrow7compute16DayOfWeekOptionsE"></span><span id="arrow::compute::DayOfWeekOptions"></span><span class="target" id="structarrow_1_1compute_1_1_day_of_week_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">DayOfWeekOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute16DayOfWeekOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_scalar.h></em></div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16DayOfWeekOptions16DayOfWeekOptionsEb8uint32_t"> |
| <span id="_CPPv3N5arrow7compute16DayOfWeekOptions16DayOfWeekOptionsEb8uint32_t"></span><span id="_CPPv2N5arrow7compute16DayOfWeekOptions16DayOfWeekOptionsEb8uint32_t"></span><span id="arrow::compute::DayOfWeekOptions::DayOfWeekOptions__b.uint32_t"></span><span class="target" id="structarrow_1_1compute_1_1_day_of_week_options_1a5df12f5ea55ff31701d5cc0a46c03d96"></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">DayOfWeekOptions</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">count_from_zero</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">uint32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">week_start</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">1</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute16DayOfWeekOptions16DayOfWeekOptionsEb8uint32_t" 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="_CPPv4N5arrow7compute16DayOfWeekOptions15count_from_zeroE"> |
| <span id="_CPPv3N5arrow7compute16DayOfWeekOptions15count_from_zeroE"></span><span id="_CPPv2N5arrow7compute16DayOfWeekOptions15count_from_zeroE"></span><span id="arrow::compute::DayOfWeekOptions::count_from_zero__b"></span><span class="target" id="structarrow_1_1compute_1_1_day_of_week_options_1a5eb7ca9b243ebd85c589adbb82dfcf8d"></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">count_from_zero</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute16DayOfWeekOptions15count_from_zeroE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Number days from 0 if true and from 1 if false. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16DayOfWeekOptions10week_startE"> |
| <span id="_CPPv3N5arrow7compute16DayOfWeekOptions10week_startE"></span><span id="_CPPv2N5arrow7compute16DayOfWeekOptions10week_startE"></span><span id="arrow::compute::DayOfWeekOptions::week_start__uint32_t"></span><span class="target" id="structarrow_1_1compute_1_1_day_of_week_options_1a86c7af7acbd2d166c824407e5f69176a"></span><span class="n"><span class="pre">uint32_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">week_start</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute16DayOfWeekOptions10week_startE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>What day does the week start with (Monday=1, Sunday=7). </p> |
| <p>The numbering is unaffected by the count_from_zero parameter. </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="_CPPv4N5arrow7compute16DayOfWeekOptions8DefaultsEv"> |
| <span id="_CPPv3N5arrow7compute16DayOfWeekOptions8DefaultsEv"></span><span id="_CPPv2N5arrow7compute16DayOfWeekOptions8DefaultsEv"></span><span id="arrow::compute::DayOfWeekOptions::Defaults"></span><span class="target" id="structarrow_1_1compute_1_1_day_of_week_options_1af125b8ddfe26b8c8303e65fb11f2f777"></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="#_CPPv4N5arrow7compute16DayOfWeekOptionsE" title="arrow::compute::DayOfWeekOptions"><span class="n"><span class="pre">DayOfWeekOptions</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="#_CPPv4N5arrow7compute16DayOfWeekOptions8DefaultsEv" 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-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16DayOfWeekOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute16DayOfWeekOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute16DayOfWeekOptions9kTypeNameE"></span><span id="arrow::compute::DayOfWeekOptions::kTypeName__cCA"></span><span class="target" id="structarrow_1_1compute_1_1_day_of_week_options_1ae38b17b65d70cfa88238ac9a1d506c05"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"DayOfWeekOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute16DayOfWeekOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute21AssumeTimezoneOptionsE"> |
| <span id="_CPPv3N5arrow7compute21AssumeTimezoneOptionsE"></span><span id="_CPPv2N5arrow7compute21AssumeTimezoneOptionsE"></span><span id="arrow::compute::AssumeTimezoneOptions"></span><span class="target" id="structarrow_1_1compute_1_1_assume_timezone_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">AssumeTimezoneOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute21AssumeTimezoneOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_scalar.h></em></div> |
| <p>Used to control timestamp timezone conversion and handling ambiguous/nonexistent times. </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 enum"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute21AssumeTimezoneOptions9AmbiguousE"> |
| <span id="_CPPv3N5arrow7compute21AssumeTimezoneOptions9AmbiguousE"></span><span id="_CPPv2N5arrow7compute21AssumeTimezoneOptions9AmbiguousE"></span><span class="target" id="structarrow_1_1compute_1_1_assume_timezone_options_1a2ba2f0dff63e89fefcf668d846ac0782"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Ambiguous</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute21AssumeTimezoneOptions9AmbiguousE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>How to interpret ambiguous local times that can be interpreted as multiple instants (normally two) due to DST shifts. </p> |
| <p>AMBIGUOUS_EARLIEST emits the earliest instant amongst possible interpretations. AMBIGUOUS_LATEST emits the latest instant amongst possible interpretations. </p> |
| <p><em>Values:</em></p> |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute21AssumeTimezoneOptions9Ambiguous15AMBIGUOUS_RAISEE"> |
| <span id="_CPPv3N5arrow7compute21AssumeTimezoneOptions9Ambiguous15AMBIGUOUS_RAISEE"></span><span id="_CPPv2N5arrow7compute21AssumeTimezoneOptions9Ambiguous15AMBIGUOUS_RAISEE"></span><span class="target" id="structarrow_1_1compute_1_1_assume_timezone_options_1a2ba2f0dff63e89fefcf668d846ac0782a074e7886095b68685567bb1ba272246d"></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">AMBIGUOUS_RAISE</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute21AssumeTimezoneOptions9Ambiguous15AMBIGUOUS_RAISEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute21AssumeTimezoneOptions9Ambiguous18AMBIGUOUS_EARLIESTE"> |
| <span id="_CPPv3N5arrow7compute21AssumeTimezoneOptions9Ambiguous18AMBIGUOUS_EARLIESTE"></span><span id="_CPPv2N5arrow7compute21AssumeTimezoneOptions9Ambiguous18AMBIGUOUS_EARLIESTE"></span><span class="target" id="structarrow_1_1compute_1_1_assume_timezone_options_1a2ba2f0dff63e89fefcf668d846ac0782a3f83ea318fa9bf6de752c17154d16a7f"></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">AMBIGUOUS_EARLIEST</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute21AssumeTimezoneOptions9Ambiguous18AMBIGUOUS_EARLIESTE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute21AssumeTimezoneOptions9Ambiguous16AMBIGUOUS_LATESTE"> |
| <span id="_CPPv3N5arrow7compute21AssumeTimezoneOptions9Ambiguous16AMBIGUOUS_LATESTE"></span><span id="_CPPv2N5arrow7compute21AssumeTimezoneOptions9Ambiguous16AMBIGUOUS_LATESTE"></span><span class="target" id="structarrow_1_1compute_1_1_assume_timezone_options_1a2ba2f0dff63e89fefcf668d846ac0782aa117e6e44627d1d43901d422119503b1"></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">AMBIGUOUS_LATEST</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute21AssumeTimezoneOptions9Ambiguous16AMBIGUOUS_LATESTE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="cpp enum"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute21AssumeTimezoneOptions11NonexistentE"> |
| <span id="_CPPv3N5arrow7compute21AssumeTimezoneOptions11NonexistentE"></span><span id="_CPPv2N5arrow7compute21AssumeTimezoneOptions11NonexistentE"></span><span class="target" id="structarrow_1_1compute_1_1_assume_timezone_options_1a15a42a991618c6b44a8de78a4b61072b"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Nonexistent</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute21AssumeTimezoneOptions11NonexistentE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>How to handle local times that do not exist due to DST shifts. </p> |
| <p>NONEXISTENT_EARLIEST emits the instant “just before” the DST shift instant in the given timestamp precision (for example, for a nanoseconds precision timestamp, this is one nanosecond before the DST shift instant). NONEXISTENT_LATEST emits the DST shift instant. </p> |
| <p><em>Values:</em></p> |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute21AssumeTimezoneOptions11Nonexistent17NONEXISTENT_RAISEE"> |
| <span id="_CPPv3N5arrow7compute21AssumeTimezoneOptions11Nonexistent17NONEXISTENT_RAISEE"></span><span id="_CPPv2N5arrow7compute21AssumeTimezoneOptions11Nonexistent17NONEXISTENT_RAISEE"></span><span class="target" id="structarrow_1_1compute_1_1_assume_timezone_options_1a15a42a991618c6b44a8de78a4b61072ba1e702181ad49fed5a6dfd137d26fb2ba"></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">NONEXISTENT_RAISE</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute21AssumeTimezoneOptions11Nonexistent17NONEXISTENT_RAISEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute21AssumeTimezoneOptions11Nonexistent20NONEXISTENT_EARLIESTE"> |
| <span id="_CPPv3N5arrow7compute21AssumeTimezoneOptions11Nonexistent20NONEXISTENT_EARLIESTE"></span><span id="_CPPv2N5arrow7compute21AssumeTimezoneOptions11Nonexistent20NONEXISTENT_EARLIESTE"></span><span class="target" id="structarrow_1_1compute_1_1_assume_timezone_options_1a15a42a991618c6b44a8de78a4b61072baec04ca9b7f8c3372a561d6ba541f8af4"></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">NONEXISTENT_EARLIEST</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute21AssumeTimezoneOptions11Nonexistent20NONEXISTENT_EARLIESTE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute21AssumeTimezoneOptions11Nonexistent18NONEXISTENT_LATESTE"> |
| <span id="_CPPv3N5arrow7compute21AssumeTimezoneOptions11Nonexistent18NONEXISTENT_LATESTE"></span><span id="_CPPv2N5arrow7compute21AssumeTimezoneOptions11Nonexistent18NONEXISTENT_LATESTE"></span><span class="target" id="structarrow_1_1compute_1_1_assume_timezone_options_1a15a42a991618c6b44a8de78a4b61072ba1fd2f45bac7370450b6c633e784e777c"></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">NONEXISTENT_LATEST</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute21AssumeTimezoneOptions11Nonexistent18NONEXISTENT_LATESTE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </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="_CPPv4N5arrow7compute21AssumeTimezoneOptions21AssumeTimezoneOptionsENSt6stringE9Ambiguous11Nonexistent"> |
| <span id="_CPPv3N5arrow7compute21AssumeTimezoneOptions21AssumeTimezoneOptionsENSt6stringE9Ambiguous11Nonexistent"></span><span id="_CPPv2N5arrow7compute21AssumeTimezoneOptions21AssumeTimezoneOptionsENSt6stringE9Ambiguous11Nonexistent"></span><span id="arrow::compute::AssumeTimezoneOptions::AssumeTimezoneOptions__ss.Ambiguous.Nonexistent"></span><span class="target" id="structarrow_1_1compute_1_1_assume_timezone_options_1acf65b02cbff980d41d3736f3b3a53b8d"></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">AssumeTimezoneOptions</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">timezone</span></span>, <a class="reference internal" href="#_CPPv4N5arrow7compute21AssumeTimezoneOptions9AmbiguousE" title="arrow::compute::AssumeTimezoneOptions::Ambiguous"><span class="n"><span class="pre">Ambiguous</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">ambiguous</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow7compute21AssumeTimezoneOptions9Ambiguous15AMBIGUOUS_RAISEE" title="arrow::compute::AssumeTimezoneOptions::AMBIGUOUS_RAISE"><span class="n"><span class="pre">AMBIGUOUS_RAISE</span></span></a>, <a class="reference internal" href="#_CPPv4N5arrow7compute21AssumeTimezoneOptions11NonexistentE" title="arrow::compute::AssumeTimezoneOptions::Nonexistent"><span class="n"><span class="pre">Nonexistent</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">nonexistent</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow7compute21AssumeTimezoneOptions11Nonexistent17NONEXISTENT_RAISEE" title="arrow::compute::AssumeTimezoneOptions::NONEXISTENT_RAISE"><span class="n"><span class="pre">NONEXISTENT_RAISE</span></span></a><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute21AssumeTimezoneOptions21AssumeTimezoneOptionsENSt6stringE9Ambiguous11Nonexistent" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute21AssumeTimezoneOptions21AssumeTimezoneOptionsEv"> |
| <span id="_CPPv3N5arrow7compute21AssumeTimezoneOptions21AssumeTimezoneOptionsEv"></span><span id="_CPPv2N5arrow7compute21AssumeTimezoneOptions21AssumeTimezoneOptionsEv"></span><span id="arrow::compute::AssumeTimezoneOptions::AssumeTimezoneOptions"></span><span class="target" id="structarrow_1_1compute_1_1_assume_timezone_options_1a196519e528a7027796c76650e8e2e632"></span><span class="sig-name descname"><span class="n"><span class="pre">AssumeTimezoneOptions</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute21AssumeTimezoneOptions21AssumeTimezoneOptionsEv" 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="_CPPv4N5arrow7compute21AssumeTimezoneOptions8timezoneE"> |
| <span id="_CPPv3N5arrow7compute21AssumeTimezoneOptions8timezoneE"></span><span id="_CPPv2N5arrow7compute21AssumeTimezoneOptions8timezoneE"></span><span id="arrow::compute::AssumeTimezoneOptions::timezone__ss"></span><span class="target" id="structarrow_1_1compute_1_1_assume_timezone_options_1ad6bf9d847c5c05181525de7768b19ba4"></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">timezone</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute21AssumeTimezoneOptions8timezoneE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Timezone to convert timestamps from. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute21AssumeTimezoneOptions9ambiguousE"> |
| <span id="_CPPv3N5arrow7compute21AssumeTimezoneOptions9ambiguousE"></span><span id="_CPPv2N5arrow7compute21AssumeTimezoneOptions9ambiguousE"></span><span id="arrow::compute::AssumeTimezoneOptions::ambiguous__Ambiguous"></span><span class="target" id="structarrow_1_1compute_1_1_assume_timezone_options_1ae6b9e329f4fa07c1a524d53d901cea3f"></span><a class="reference internal" href="#_CPPv4N5arrow7compute21AssumeTimezoneOptions9AmbiguousE" title="arrow::compute::AssumeTimezoneOptions::Ambiguous"><span class="n"><span class="pre">Ambiguous</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ambiguous</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute21AssumeTimezoneOptions9ambiguousE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>How to interpret ambiguous local times (due to DST shifts) </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute21AssumeTimezoneOptions11nonexistentE"> |
| <span id="_CPPv3N5arrow7compute21AssumeTimezoneOptions11nonexistentE"></span><span id="_CPPv2N5arrow7compute21AssumeTimezoneOptions11nonexistentE"></span><span id="arrow::compute::AssumeTimezoneOptions::nonexistent__Nonexistent"></span><span class="target" id="structarrow_1_1compute_1_1_assume_timezone_options_1a3de962d098a14b8814bb346e1f85eaf7"></span><a class="reference internal" href="#_CPPv4N5arrow7compute21AssumeTimezoneOptions11NonexistentE" title="arrow::compute::AssumeTimezoneOptions::Nonexistent"><span class="n"><span class="pre">Nonexistent</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">nonexistent</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute21AssumeTimezoneOptions11nonexistentE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>How to interpret nonexistent local times (due to DST shifts) </p> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-static-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute21AssumeTimezoneOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute21AssumeTimezoneOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute21AssumeTimezoneOptions9kTypeNameE"></span><span id="arrow::compute::AssumeTimezoneOptions::kTypeName__cCA"></span><span class="target" id="structarrow_1_1compute_1_1_assume_timezone_options_1a8f67871dd32e7d78a9e2165e6ccc4d41"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"AssumeTimezoneOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute21AssumeTimezoneOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11WeekOptionsE"> |
| <span id="_CPPv3N5arrow7compute11WeekOptionsE"></span><span id="_CPPv2N5arrow7compute11WeekOptionsE"></span><span id="arrow::compute::WeekOptions"></span><span class="target" id="structarrow_1_1compute_1_1_week_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">WeekOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute11WeekOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_scalar.h></em></div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11WeekOptions11WeekOptionsEbbb"> |
| <span id="_CPPv3N5arrow7compute11WeekOptions11WeekOptionsEbbb"></span><span id="_CPPv2N5arrow7compute11WeekOptions11WeekOptionsEbbb"></span><span id="arrow::compute::WeekOptions::WeekOptions__b.b.b"></span><span class="target" id="structarrow_1_1compute_1_1_week_options_1ada701a827677f0c3cfa5b2eb6feb92cb"></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">WeekOptions</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">week_starts_monday</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="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">count_from_zero</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="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">first_week_is_fully_in_year</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="#_CPPv4N5arrow7compute11WeekOptions11WeekOptionsEbbb" 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="_CPPv4N5arrow7compute11WeekOptions18week_starts_mondayE"> |
| <span id="_CPPv3N5arrow7compute11WeekOptions18week_starts_mondayE"></span><span id="_CPPv2N5arrow7compute11WeekOptions18week_starts_mondayE"></span><span id="arrow::compute::WeekOptions::week_starts_monday__b"></span><span class="target" id="structarrow_1_1compute_1_1_week_options_1af3e44e0237cb1b8478d9263a76f86693"></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">week_starts_monday</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11WeekOptions18week_starts_mondayE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>What day does the week start with (Monday=true, Sunday=false) </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11WeekOptions15count_from_zeroE"> |
| <span id="_CPPv3N5arrow7compute11WeekOptions15count_from_zeroE"></span><span id="_CPPv2N5arrow7compute11WeekOptions15count_from_zeroE"></span><span id="arrow::compute::WeekOptions::count_from_zero__b"></span><span class="target" id="structarrow_1_1compute_1_1_week_options_1a09027c2fec85e4dcdd3aa75eda6c8d4a"></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">count_from_zero</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11WeekOptions15count_from_zeroE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Dates from current year that fall into last ISO week of the previous year return 0 if true and 52 or 53 if false. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11WeekOptions27first_week_is_fully_in_yearE"> |
| <span id="_CPPv3N5arrow7compute11WeekOptions27first_week_is_fully_in_yearE"></span><span id="_CPPv2N5arrow7compute11WeekOptions27first_week_is_fully_in_yearE"></span><span id="arrow::compute::WeekOptions::first_week_is_fully_in_year__b"></span><span class="target" id="structarrow_1_1compute_1_1_week_options_1a733e47b4302b4d0fa05aa7eba228aff5"></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">first_week_is_fully_in_year</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11WeekOptions27first_week_is_fully_in_yearE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Must the first week be fully in January (true), or is a week that begins on December 29, 30, or 31 considered to be the first week of the new year (false)? </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="_CPPv4N5arrow7compute11WeekOptions8DefaultsEv"> |
| <span id="_CPPv3N5arrow7compute11WeekOptions8DefaultsEv"></span><span id="_CPPv2N5arrow7compute11WeekOptions8DefaultsEv"></span><span id="arrow::compute::WeekOptions::Defaults"></span><span class="target" id="structarrow_1_1compute_1_1_week_options_1af04b7be963d320259b3353aa358865c6"></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="#_CPPv4N5arrow7compute11WeekOptionsE" title="arrow::compute::WeekOptions"><span class="n"><span class="pre">WeekOptions</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="#_CPPv4N5arrow7compute11WeekOptions8DefaultsEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11WeekOptions11ISODefaultsEv"> |
| <span id="_CPPv3N5arrow7compute11WeekOptions11ISODefaultsEv"></span><span id="_CPPv2N5arrow7compute11WeekOptions11ISODefaultsEv"></span><span id="arrow::compute::WeekOptions::ISODefaults"></span><span class="target" id="structarrow_1_1compute_1_1_week_options_1a321a5d7e5b865aeec7b44f2999bd1a26"></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="#_CPPv4N5arrow7compute11WeekOptionsE" title="arrow::compute::WeekOptions"><span class="n"><span class="pre">WeekOptions</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ISODefaults</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute11WeekOptions11ISODefaultsEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11WeekOptions10USDefaultsEv"> |
| <span id="_CPPv3N5arrow7compute11WeekOptions10USDefaultsEv"></span><span id="_CPPv2N5arrow7compute11WeekOptions10USDefaultsEv"></span><span id="arrow::compute::WeekOptions::USDefaults"></span><span class="target" id="structarrow_1_1compute_1_1_week_options_1a188a2e39ef874eda917fe4ea0f08fc12"></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="#_CPPv4N5arrow7compute11WeekOptionsE" title="arrow::compute::WeekOptions"><span class="n"><span class="pre">WeekOptions</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">USDefaults</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute11WeekOptions10USDefaultsEv" 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-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11WeekOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute11WeekOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute11WeekOptions9kTypeNameE"></span><span id="arrow::compute::WeekOptions::kTypeName__cCA"></span><span class="target" id="structarrow_1_1compute_1_1_week_options_1ae758773e7b22f66525916eb08835d075"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"WeekOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11WeekOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute20Utf8NormalizeOptionsE"> |
| <span id="_CPPv3N5arrow7compute20Utf8NormalizeOptionsE"></span><span id="_CPPv2N5arrow7compute20Utf8NormalizeOptionsE"></span><span id="arrow::compute::Utf8NormalizeOptions"></span><span class="target" id="structarrow_1_1compute_1_1_utf8_normalize_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">Utf8NormalizeOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute20Utf8NormalizeOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_scalar.h></em></div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-types">Public Types</p> |
| <dl class="cpp enum"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute20Utf8NormalizeOptions4FormE"> |
| <span id="_CPPv3N5arrow7compute20Utf8NormalizeOptions4FormE"></span><span id="_CPPv2N5arrow7compute20Utf8NormalizeOptions4FormE"></span><span class="target" id="structarrow_1_1compute_1_1_utf8_normalize_options_1a6e25cc10b60ba13bcd42e0a51150ed87"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Form</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute20Utf8NormalizeOptions4FormE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p><em>Values:</em></p> |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute20Utf8NormalizeOptions4Form3NFCE"> |
| <span id="_CPPv3N5arrow7compute20Utf8NormalizeOptions4Form3NFCE"></span><span id="_CPPv2N5arrow7compute20Utf8NormalizeOptions4Form3NFCE"></span><span class="target" id="structarrow_1_1compute_1_1_utf8_normalize_options_1a6e25cc10b60ba13bcd42e0a51150ed87a26104309e1f04833b21d4a5cf3e42bc5"></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">NFC</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute20Utf8NormalizeOptions4Form3NFCE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute20Utf8NormalizeOptions4Form4NFKCE"> |
| <span id="_CPPv3N5arrow7compute20Utf8NormalizeOptions4Form4NFKCE"></span><span id="_CPPv2N5arrow7compute20Utf8NormalizeOptions4Form4NFKCE"></span><span class="target" id="structarrow_1_1compute_1_1_utf8_normalize_options_1a6e25cc10b60ba13bcd42e0a51150ed87a3a6c9606aecd8bfc036169febc720f5b"></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">NFKC</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute20Utf8NormalizeOptions4Form4NFKCE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute20Utf8NormalizeOptions4Form3NFDE"> |
| <span id="_CPPv3N5arrow7compute20Utf8NormalizeOptions4Form3NFDE"></span><span id="_CPPv2N5arrow7compute20Utf8NormalizeOptions4Form3NFDE"></span><span class="target" id="structarrow_1_1compute_1_1_utf8_normalize_options_1a6e25cc10b60ba13bcd42e0a51150ed87a6863c453b48927bbd3ecae9679d6d7c6"></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">NFD</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute20Utf8NormalizeOptions4Form3NFDE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute20Utf8NormalizeOptions4Form4NFKDE"> |
| <span id="_CPPv3N5arrow7compute20Utf8NormalizeOptions4Form4NFKDE"></span><span id="_CPPv2N5arrow7compute20Utf8NormalizeOptions4Form4NFKDE"></span><span class="target" id="structarrow_1_1compute_1_1_utf8_normalize_options_1a6e25cc10b60ba13bcd42e0a51150ed87a73737a81166d8216fa3be738022e62ae"></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">NFKD</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute20Utf8NormalizeOptions4Form4NFKDE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </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="_CPPv4N5arrow7compute20Utf8NormalizeOptions20Utf8NormalizeOptionsE4Form"> |
| <span id="_CPPv3N5arrow7compute20Utf8NormalizeOptions20Utf8NormalizeOptionsE4Form"></span><span id="_CPPv2N5arrow7compute20Utf8NormalizeOptions20Utf8NormalizeOptionsE4Form"></span><span id="arrow::compute::Utf8NormalizeOptions::Utf8NormalizeOptions__Form"></span><span class="target" id="structarrow_1_1compute_1_1_utf8_normalize_options_1a4da26235e616357c9a56f3252d6417f6"></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">Utf8NormalizeOptions</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4N5arrow7compute20Utf8NormalizeOptions4FormE" title="arrow::compute::Utf8NormalizeOptions::Form"><span class="n"><span class="pre">Form</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">form</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow7compute20Utf8NormalizeOptions4Form3NFCE" title="arrow::compute::Utf8NormalizeOptions::NFC"><span class="n"><span class="pre">NFC</span></span></a><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute20Utf8NormalizeOptions20Utf8NormalizeOptionsE4Form" 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="_CPPv4N5arrow7compute20Utf8NormalizeOptions4formE"> |
| <span id="_CPPv3N5arrow7compute20Utf8NormalizeOptions4formE"></span><span id="_CPPv2N5arrow7compute20Utf8NormalizeOptions4formE"></span><span id="arrow::compute::Utf8NormalizeOptions::form__Form"></span><span class="target" id="structarrow_1_1compute_1_1_utf8_normalize_options_1adf47477bc865e0a1a95413f14973f93b"></span><a class="reference internal" href="#_CPPv4N5arrow7compute20Utf8NormalizeOptions4FormE" title="arrow::compute::Utf8NormalizeOptions::Form"><span class="n"><span class="pre">Form</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">form</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute20Utf8NormalizeOptions4formE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The Unicode normalization form to apply. </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="_CPPv4N5arrow7compute20Utf8NormalizeOptions8DefaultsEv"> |
| <span id="_CPPv3N5arrow7compute20Utf8NormalizeOptions8DefaultsEv"></span><span id="_CPPv2N5arrow7compute20Utf8NormalizeOptions8DefaultsEv"></span><span id="arrow::compute::Utf8NormalizeOptions::Defaults"></span><span class="target" id="structarrow_1_1compute_1_1_utf8_normalize_options_1ab13fc82ffc7489f88bdabd852c76269d"></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="#_CPPv4N5arrow7compute20Utf8NormalizeOptionsE" title="arrow::compute::Utf8NormalizeOptions"><span class="n"><span class="pre">Utf8NormalizeOptions</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="#_CPPv4N5arrow7compute20Utf8NormalizeOptions8DefaultsEv" 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-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute20Utf8NormalizeOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute20Utf8NormalizeOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute20Utf8NormalizeOptions9kTypeNameE"></span><span id="arrow::compute::Utf8NormalizeOptions::kTypeName__cCA"></span><span class="target" id="structarrow_1_1compute_1_1_utf8_normalize_options_1ab63d41412450ac7fb0c88fe00385e2c4"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"Utf8NormalizeOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute20Utf8NormalizeOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute13RandomOptionsE"> |
| <span id="_CPPv3N5arrow7compute13RandomOptionsE"></span><span id="_CPPv2N5arrow7compute13RandomOptionsE"></span><span id="arrow::compute::RandomOptions"></span><span class="target" id="classarrow_1_1compute_1_1_random_options"></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">RandomOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute13RandomOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_scalar.h></em></div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-types">Public Types</p> |
| <dl class="cpp enum"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute13RandomOptions11InitializerE"> |
| <span id="_CPPv3N5arrow7compute13RandomOptions11InitializerE"></span><span id="_CPPv2N5arrow7compute13RandomOptions11InitializerE"></span><span class="target" id="classarrow_1_1compute_1_1_random_options_1a2b84d5511c8d225212fc3e0ee9c0537e"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Initializer</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute13RandomOptions11InitializerE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p><em>Values:</em></p> |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute13RandomOptions11Initializer12SystemRandomE"> |
| <span id="_CPPv3N5arrow7compute13RandomOptions11Initializer12SystemRandomE"></span><span id="_CPPv2N5arrow7compute13RandomOptions11Initializer12SystemRandomE"></span><span class="target" id="classarrow_1_1compute_1_1_random_options_1a2b84d5511c8d225212fc3e0ee9c0537ea0f29bb3306d0334b497f460d84fac91d"></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">SystemRandom</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute13RandomOptions11Initializer12SystemRandomE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute13RandomOptions11Initializer4SeedE"> |
| <span id="_CPPv3N5arrow7compute13RandomOptions11Initializer4SeedE"></span><span id="_CPPv2N5arrow7compute13RandomOptions11Initializer4SeedE"></span><span class="target" id="classarrow_1_1compute_1_1_random_options_1a2b84d5511c8d225212fc3e0ee9c0537ea291af60b5605ebc07636ee78a41f4128"></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">Seed</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute13RandomOptions11Initializer4SeedE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </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="_CPPv4N5arrow7compute13RandomOptions13RandomOptionsE11Initializer8uint64_t"> |
| <span id="_CPPv3N5arrow7compute13RandomOptions13RandomOptionsE11Initializer8uint64_t"></span><span id="_CPPv2N5arrow7compute13RandomOptions13RandomOptionsE11Initializer8uint64_t"></span><span id="arrow::compute::RandomOptions::RandomOptions__Initializer.uint64_t"></span><span class="target" id="classarrow_1_1compute_1_1_random_options_1a9621677a4f40311ce5ecbb7616053a68"></span><span class="sig-name descname"><span class="n"><span class="pre">RandomOptions</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4N5arrow7compute13RandomOptions11InitializerE" title="arrow::compute::RandomOptions::Initializer"><span class="n"><span class="pre">Initializer</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">initializer</span></span>, <span class="n"><span class="pre">uint64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">seed</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute13RandomOptions13RandomOptionsE11Initializer8uint64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute13RandomOptions13RandomOptionsEv"> |
| <span id="_CPPv3N5arrow7compute13RandomOptions13RandomOptionsEv"></span><span id="_CPPv2N5arrow7compute13RandomOptions13RandomOptionsEv"></span><span id="arrow::compute::RandomOptions::RandomOptions"></span><span class="target" id="classarrow_1_1compute_1_1_random_options_1a80971298a842ac6920eba4a9eb7b16b8"></span><span class="sig-name descname"><span class="n"><span class="pre">RandomOptions</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute13RandomOptions13RandomOptionsEv" 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="_CPPv4N5arrow7compute13RandomOptions11initializerE"> |
| <span id="_CPPv3N5arrow7compute13RandomOptions11initializerE"></span><span id="_CPPv2N5arrow7compute13RandomOptions11initializerE"></span><span id="arrow::compute::RandomOptions::initializer__Initializer"></span><span class="target" id="classarrow_1_1compute_1_1_random_options_1a010a9ca80e0851d052a253bba8258d38"></span><a class="reference internal" href="#_CPPv4N5arrow7compute13RandomOptions11InitializerE" title="arrow::compute::RandomOptions::Initializer"><span class="n"><span class="pre">Initializer</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">initializer</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute13RandomOptions11initializerE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The type of initialization for random number generation - system or provided seed. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute13RandomOptions4seedE"> |
| <span id="_CPPv3N5arrow7compute13RandomOptions4seedE"></span><span id="_CPPv2N5arrow7compute13RandomOptions4seedE"></span><span id="arrow::compute::RandomOptions::seed__uint64_t"></span><span class="target" id="classarrow_1_1compute_1_1_random_options_1a058121b02ca56558218c6cfc6e358ce3"></span><span class="n"><span class="pre">uint64_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">seed</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute13RandomOptions4seedE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The seed value used to initialize the random number generation. </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="_CPPv4N5arrow7compute13RandomOptions16FromSystemRandomEv"> |
| <span id="_CPPv3N5arrow7compute13RandomOptions16FromSystemRandomEv"></span><span id="_CPPv2N5arrow7compute13RandomOptions16FromSystemRandomEv"></span><span id="arrow::compute::RandomOptions::FromSystemRandom"></span><span class="target" id="classarrow_1_1compute_1_1_random_options_1a099869293dfffe4b06d4ee0099506c1b"></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="#_CPPv4N5arrow7compute13RandomOptionsE" title="arrow::compute::RandomOptions"><span class="n"><span class="pre">RandomOptions</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FromSystemRandom</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute13RandomOptions16FromSystemRandomEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute13RandomOptions8FromSeedE8uint64_t"> |
| <span id="_CPPv3N5arrow7compute13RandomOptions8FromSeedE8uint64_t"></span><span id="_CPPv2N5arrow7compute13RandomOptions8FromSeedE8uint64_t"></span><span id="arrow::compute::RandomOptions::FromSeed__uint64_t"></span><span class="target" id="classarrow_1_1compute_1_1_random_options_1a8bb7eba144659620c96a5bf5118d2bf7"></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="#_CPPv4N5arrow7compute13RandomOptionsE" title="arrow::compute::RandomOptions"><span class="n"><span class="pre">RandomOptions</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FromSeed</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">uint64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">seed</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute13RandomOptions8FromSeedE8uint64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute13RandomOptions8DefaultsEv"> |
| <span id="_CPPv3N5arrow7compute13RandomOptions8DefaultsEv"></span><span id="_CPPv2N5arrow7compute13RandomOptions8DefaultsEv"></span><span id="arrow::compute::RandomOptions::Defaults"></span><span class="target" id="classarrow_1_1compute_1_1_random_options_1a14346671c881e524d87bd3da0a733754"></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="#_CPPv4N5arrow7compute13RandomOptionsE" title="arrow::compute::RandomOptions"><span class="n"><span class="pre">RandomOptions</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="#_CPPv4N5arrow7compute13RandomOptions8DefaultsEv" 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-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute13RandomOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute13RandomOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute13RandomOptions9kTypeNameE"></span><span id="arrow::compute::RandomOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_random_options_1a008e36955c297250bd16a7c0903fffe5"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"RandomOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute13RandomOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16MapLookupOptionsE"> |
| <span id="_CPPv3N5arrow7compute16MapLookupOptionsE"></span><span id="_CPPv2N5arrow7compute16MapLookupOptionsE"></span><span id="arrow::compute::MapLookupOptions"></span><span class="target" id="classarrow_1_1compute_1_1_map_lookup_options"></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">MapLookupOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute16MapLookupOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_scalar.h></em></div> |
| <p>Options for map_lookup function. </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 enum"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16MapLookupOptions10OccurrenceE"> |
| <span id="_CPPv3N5arrow7compute16MapLookupOptions10OccurrenceE"></span><span id="_CPPv2N5arrow7compute16MapLookupOptions10OccurrenceE"></span><span class="target" id="classarrow_1_1compute_1_1_map_lookup_options_1af2d1d7254210fe01de5ec1f165627a04"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Occurrence</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute16MapLookupOptions10OccurrenceE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p><em>Values:</em></p> |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16MapLookupOptions10Occurrence5FIRSTE"> |
| <span id="_CPPv3N5arrow7compute16MapLookupOptions10Occurrence5FIRSTE"></span><span id="_CPPv2N5arrow7compute16MapLookupOptions10Occurrence5FIRSTE"></span><span class="target" id="classarrow_1_1compute_1_1_map_lookup_options_1af2d1d7254210fe01de5ec1f165627a04a8edc467131a57b6fa28da9f7831c4765"></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">FIRST</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute16MapLookupOptions10Occurrence5FIRSTE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the first matching value. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16MapLookupOptions10Occurrence4LASTE"> |
| <span id="_CPPv3N5arrow7compute16MapLookupOptions10Occurrence4LASTE"></span><span id="_CPPv2N5arrow7compute16MapLookupOptions10Occurrence4LASTE"></span><span class="target" id="classarrow_1_1compute_1_1_map_lookup_options_1af2d1d7254210fe01de5ec1f165627a04a1c88e7d24234e38d27c3ac621e8ed669"></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">LAST</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute16MapLookupOptions10Occurrence4LASTE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the last matching value. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16MapLookupOptions10Occurrence3ALLE"> |
| <span id="_CPPv3N5arrow7compute16MapLookupOptions10Occurrence3ALLE"></span><span id="_CPPv2N5arrow7compute16MapLookupOptions10Occurrence3ALLE"></span><span class="target" id="classarrow_1_1compute_1_1_map_lookup_options_1af2d1d7254210fe01de5ec1f165627a04a1a001a49a9c72b58c5501925aaa58f51"></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">ALL</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute16MapLookupOptions10Occurrence3ALLE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return all matching values. </p> |
| </dd></dl> |
| |
| </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="_CPPv4N5arrow7compute16MapLookupOptions16MapLookupOptionsENSt10shared_ptrI6ScalarEE10Occurrence"> |
| <span id="_CPPv3N5arrow7compute16MapLookupOptions16MapLookupOptionsENSt10shared_ptrI6ScalarEE10Occurrence"></span><span id="_CPPv2N5arrow7compute16MapLookupOptions16MapLookupOptionsENSt10shared_ptrI6ScalarEE10Occurrence"></span><span id="arrow::compute::MapLookupOptions::MapLookupOptions__std::shared_ptr:Scalar:.Occurrence"></span><span class="target" id="classarrow_1_1compute_1_1_map_lookup_options_1aa7372ef7b2215388aded40ac1657c976"></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">MapLookupOptions</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="scalar.html#_CPPv4N5arrow6ScalarE" title="arrow::Scalar"><span class="n"><span class="pre">Scalar</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">query_key</span></span>, <a class="reference internal" href="#_CPPv4N5arrow7compute16MapLookupOptions10OccurrenceE" title="arrow::compute::MapLookupOptions::Occurrence"><span class="n"><span class="pre">Occurrence</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">occurrence</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute16MapLookupOptions16MapLookupOptionsENSt10shared_ptrI6ScalarEE10Occurrence" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16MapLookupOptions16MapLookupOptionsEv"> |
| <span id="_CPPv3N5arrow7compute16MapLookupOptions16MapLookupOptionsEv"></span><span id="_CPPv2N5arrow7compute16MapLookupOptions16MapLookupOptionsEv"></span><span id="arrow::compute::MapLookupOptions::MapLookupOptions"></span><span class="target" id="classarrow_1_1compute_1_1_map_lookup_options_1a0f08a3db25d3765554b2033aaa19b5b9"></span><span class="sig-name descname"><span class="n"><span class="pre">MapLookupOptions</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute16MapLookupOptions16MapLookupOptionsEv" 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="_CPPv4N5arrow7compute16MapLookupOptions9query_keyE"> |
| <span id="_CPPv3N5arrow7compute16MapLookupOptions9query_keyE"></span><span id="_CPPv2N5arrow7compute16MapLookupOptions9query_keyE"></span><span id="arrow::compute::MapLookupOptions::query_key__std::shared_ptr:Scalar:"></span><span class="target" id="classarrow_1_1compute_1_1_map_lookup_options_1af404e14c71cea01dca7df0ce4c18c792"></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="scalar.html#_CPPv4N5arrow6ScalarE" title="arrow::Scalar"><span class="n"><span class="pre">Scalar</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">query_key</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute16MapLookupOptions9query_keyE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The key to lookup in the map. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16MapLookupOptions10occurrenceE"> |
| <span id="_CPPv3N5arrow7compute16MapLookupOptions10occurrenceE"></span><span id="_CPPv2N5arrow7compute16MapLookupOptions10occurrenceE"></span><span id="arrow::compute::MapLookupOptions::occurrence__Occurrence"></span><span class="target" id="classarrow_1_1compute_1_1_map_lookup_options_1a3276c70b4b3547d02e392c3e4553448c"></span><a class="reference internal" href="#_CPPv4N5arrow7compute16MapLookupOptions10OccurrenceE" title="arrow::compute::MapLookupOptions::Occurrence"><span class="n"><span class="pre">Occurrence</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">occurrence</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute16MapLookupOptions10occurrenceE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Whether to return the first, last, or all matching values. </p> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-static-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16MapLookupOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute16MapLookupOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute16MapLookupOptions9kTypeNameE"></span><span id="arrow::compute::MapLookupOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_map_lookup_options_1af93f0aa7a239e32eb2e65cae97e8d8ad"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"MapLookupOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute16MapLookupOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute13FilterOptionsE"> |
| <span id="_CPPv3N5arrow7compute13FilterOptionsE"></span><span id="_CPPv2N5arrow7compute13FilterOptionsE"></span><span id="arrow::compute::FilterOptions"></span><span class="target" id="classarrow_1_1compute_1_1_filter_options"></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">FilterOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute13FilterOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_vector.h></em></div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-types">Public Types</p> |
| <dl class="cpp enum"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute13FilterOptions21NullSelectionBehaviorE"> |
| <span id="_CPPv3N5arrow7compute13FilterOptions21NullSelectionBehaviorE"></span><span id="_CPPv2N5arrow7compute13FilterOptions21NullSelectionBehaviorE"></span><span class="target" id="classarrow_1_1compute_1_1_filter_options_1a59e8d96f3c5a15b0b2615a5cf0b00c9e"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">NullSelectionBehavior</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute13FilterOptions21NullSelectionBehaviorE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Configure the action taken when a slot of the selection mask is null. </p> |
| <p><em>Values:</em></p> |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute13FilterOptions21NullSelectionBehavior4DROPE"> |
| <span id="_CPPv3N5arrow7compute13FilterOptions21NullSelectionBehavior4DROPE"></span><span id="_CPPv2N5arrow7compute13FilterOptions21NullSelectionBehavior4DROPE"></span><span class="target" id="classarrow_1_1compute_1_1_filter_options_1a59e8d96f3c5a15b0b2615a5cf0b00c9ea36fbcadb18b9fc35beaeee6b41279128"></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">DROP</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute13FilterOptions21NullSelectionBehavior4DROPE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The corresponding filtered value will be removed in the output. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute13FilterOptions21NullSelectionBehavior9EMIT_NULLE"> |
| <span id="_CPPv3N5arrow7compute13FilterOptions21NullSelectionBehavior9EMIT_NULLE"></span><span id="_CPPv2N5arrow7compute13FilterOptions21NullSelectionBehavior9EMIT_NULLE"></span><span class="target" id="classarrow_1_1compute_1_1_filter_options_1a59e8d96f3c5a15b0b2615a5cf0b00c9ea4f926337500f2dad89aae29651a77ae7"></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">EMIT_NULL</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute13FilterOptions21NullSelectionBehavior9EMIT_NULLE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The corresponding filtered value will be null in the output. </p> |
| </dd></dl> |
| |
| </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="_CPPv4N5arrow7compute13FilterOptions13FilterOptionsE21NullSelectionBehavior"> |
| <span id="_CPPv3N5arrow7compute13FilterOptions13FilterOptionsE21NullSelectionBehavior"></span><span id="_CPPv2N5arrow7compute13FilterOptions13FilterOptionsE21NullSelectionBehavior"></span><span id="arrow::compute::FilterOptions::FilterOptions__NullSelectionBehavior"></span><span class="target" id="classarrow_1_1compute_1_1_filter_options_1a60841f661155cebad05ba25ce5d196d1"></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">FilterOptions</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4N5arrow7compute13FilterOptions21NullSelectionBehaviorE" title="arrow::compute::FilterOptions::NullSelectionBehavior"><span class="n"><span class="pre">NullSelectionBehavior</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">null_selection</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow7compute13FilterOptions21NullSelectionBehavior4DROPE" title="arrow::compute::FilterOptions::DROP"><span class="n"><span class="pre">DROP</span></span></a><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute13FilterOptions13FilterOptionsE21NullSelectionBehavior" 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="_CPPv4N5arrow7compute13FilterOptions23null_selection_behaviorE"> |
| <span id="_CPPv3N5arrow7compute13FilterOptions23null_selection_behaviorE"></span><span id="_CPPv2N5arrow7compute13FilterOptions23null_selection_behaviorE"></span><span id="arrow::compute::FilterOptions::null_selection_behavior__NullSelectionBehavior"></span><span class="target" id="classarrow_1_1compute_1_1_filter_options_1a902fb426f845d1f7f8b9da162c199650"></span><a class="reference internal" href="#_CPPv4N5arrow7compute13FilterOptions21NullSelectionBehaviorE" title="arrow::compute::FilterOptions::NullSelectionBehavior"><span class="n"><span class="pre">NullSelectionBehavior</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">null_selection_behavior</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow7compute13FilterOptions21NullSelectionBehavior4DROPE" title="arrow::compute::FilterOptions::DROP"><span class="n"><span class="pre">DROP</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute13FilterOptions23null_selection_behaviorE" 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="_CPPv4N5arrow7compute13FilterOptions8DefaultsEv"> |
| <span id="_CPPv3N5arrow7compute13FilterOptions8DefaultsEv"></span><span id="_CPPv2N5arrow7compute13FilterOptions8DefaultsEv"></span><span id="arrow::compute::FilterOptions::Defaults"></span><span class="target" id="classarrow_1_1compute_1_1_filter_options_1a5f24b2cfd788015ffd4f551a12111f6e"></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="#_CPPv4N5arrow7compute13FilterOptionsE" title="arrow::compute::FilterOptions"><span class="n"><span class="pre">FilterOptions</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="#_CPPv4N5arrow7compute13FilterOptions8DefaultsEv" 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-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute13FilterOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute13FilterOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute13FilterOptions9kTypeNameE"></span><span id="arrow::compute::FilterOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_filter_options_1a7bedac6ef95a54efe85e312e30ca74df"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"FilterOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute13FilterOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11TakeOptionsE"> |
| <span id="_CPPv3N5arrow7compute11TakeOptionsE"></span><span id="_CPPv2N5arrow7compute11TakeOptionsE"></span><span id="arrow::compute::TakeOptions"></span><span class="target" id="classarrow_1_1compute_1_1_take_options"></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">TakeOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute11TakeOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_vector.h></em></div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11TakeOptions11TakeOptionsEb"> |
| <span id="_CPPv3N5arrow7compute11TakeOptions11TakeOptionsEb"></span><span id="_CPPv2N5arrow7compute11TakeOptions11TakeOptionsEb"></span><span id="arrow::compute::TakeOptions::TakeOptions__b"></span><span class="target" id="classarrow_1_1compute_1_1_take_options_1aa951f77433a401dccb8faf884641e851"></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">TakeOptions</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">boundscheck</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="k"><span class="pre">true</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute11TakeOptions11TakeOptionsEb" 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="_CPPv4N5arrow7compute11TakeOptions11boundscheckE"> |
| <span id="_CPPv3N5arrow7compute11TakeOptions11boundscheckE"></span><span id="_CPPv2N5arrow7compute11TakeOptions11boundscheckE"></span><span id="arrow::compute::TakeOptions::boundscheck__b"></span><span class="target" id="classarrow_1_1compute_1_1_take_options_1a5dd9c6537a9096196398a3cf65422ec1"></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">boundscheck</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="#_CPPv4N5arrow7compute11TakeOptions11boundscheckE" 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="_CPPv4N5arrow7compute11TakeOptions11BoundsCheckEv"> |
| <span id="_CPPv3N5arrow7compute11TakeOptions11BoundsCheckEv"></span><span id="_CPPv2N5arrow7compute11TakeOptions11BoundsCheckEv"></span><span id="arrow::compute::TakeOptions::BoundsCheck"></span><span class="target" id="classarrow_1_1compute_1_1_take_options_1a4ddc936b9d93859123a62b136847e4f5"></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="#_CPPv4N5arrow7compute11TakeOptionsE" title="arrow::compute::TakeOptions"><span class="n"><span class="pre">TakeOptions</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">BoundsCheck</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute11TakeOptions11BoundsCheckEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11TakeOptions13NoBoundsCheckEv"> |
| <span id="_CPPv3N5arrow7compute11TakeOptions13NoBoundsCheckEv"></span><span id="_CPPv2N5arrow7compute11TakeOptions13NoBoundsCheckEv"></span><span id="arrow::compute::TakeOptions::NoBoundsCheck"></span><span class="target" id="classarrow_1_1compute_1_1_take_options_1ad8b5f4b2c2c6eef41d6324ec6e15149d"></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="#_CPPv4N5arrow7compute11TakeOptionsE" title="arrow::compute::TakeOptions"><span class="n"><span class="pre">TakeOptions</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">NoBoundsCheck</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute11TakeOptions13NoBoundsCheckEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11TakeOptions8DefaultsEv"> |
| <span id="_CPPv3N5arrow7compute11TakeOptions8DefaultsEv"></span><span id="_CPPv2N5arrow7compute11TakeOptions8DefaultsEv"></span><span id="arrow::compute::TakeOptions::Defaults"></span><span class="target" id="classarrow_1_1compute_1_1_take_options_1a50487f7587a8e9367faa21a7fd88abb1"></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="#_CPPv4N5arrow7compute11TakeOptionsE" title="arrow::compute::TakeOptions"><span class="n"><span class="pre">TakeOptions</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="#_CPPv4N5arrow7compute11TakeOptions8DefaultsEv" 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-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11TakeOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute11TakeOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute11TakeOptions9kTypeNameE"></span><span id="arrow::compute::TakeOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_take_options_1a2f9781154e77fb1a6addafe320ea10ea"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"TakeOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11TakeOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute23DictionaryEncodeOptionsE"> |
| <span id="_CPPv3N5arrow7compute23DictionaryEncodeOptionsE"></span><span id="_CPPv2N5arrow7compute23DictionaryEncodeOptionsE"></span><span id="arrow::compute::DictionaryEncodeOptions"></span><span class="target" id="classarrow_1_1compute_1_1_dictionary_encode_options"></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">DictionaryEncodeOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute23DictionaryEncodeOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_vector.h></em></div> |
| <p>Options for the dictionary encode function. </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 enum"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute23DictionaryEncodeOptions20NullEncodingBehaviorE"> |
| <span id="_CPPv3N5arrow7compute23DictionaryEncodeOptions20NullEncodingBehaviorE"></span><span id="_CPPv2N5arrow7compute23DictionaryEncodeOptions20NullEncodingBehaviorE"></span><span class="target" id="classarrow_1_1compute_1_1_dictionary_encode_options_1ace68c5d8329389ca1e9e5f909be0351a"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">NullEncodingBehavior</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute23DictionaryEncodeOptions20NullEncodingBehaviorE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Configure how null values will be encoded. </p> |
| <p><em>Values:</em></p> |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute23DictionaryEncodeOptions20NullEncodingBehavior6ENCODEE"> |
| <span id="_CPPv3N5arrow7compute23DictionaryEncodeOptions20NullEncodingBehavior6ENCODEE"></span><span id="_CPPv2N5arrow7compute23DictionaryEncodeOptions20NullEncodingBehavior6ENCODEE"></span><span class="target" id="classarrow_1_1compute_1_1_dictionary_encode_options_1ace68c5d8329389ca1e9e5f909be0351aa45283238a434269d6cb04b4683213eee"></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">ENCODE</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute23DictionaryEncodeOptions20NullEncodingBehavior6ENCODEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The null value will be added to the dictionary with a proper index. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute23DictionaryEncodeOptions20NullEncodingBehavior4MASKE"> |
| <span id="_CPPv3N5arrow7compute23DictionaryEncodeOptions20NullEncodingBehavior4MASKE"></span><span id="_CPPv2N5arrow7compute23DictionaryEncodeOptions20NullEncodingBehavior4MASKE"></span><span class="target" id="classarrow_1_1compute_1_1_dictionary_encode_options_1ace68c5d8329389ca1e9e5f909be0351aac9f44857ee500eebd98723ec09047fa7"></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">MASK</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute23DictionaryEncodeOptions20NullEncodingBehavior4MASKE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The null value will be masked in the indices array. </p> |
| </dd></dl> |
| |
| </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="_CPPv4N5arrow7compute23DictionaryEncodeOptions23DictionaryEncodeOptionsE20NullEncodingBehavior"> |
| <span id="_CPPv3N5arrow7compute23DictionaryEncodeOptions23DictionaryEncodeOptionsE20NullEncodingBehavior"></span><span id="_CPPv2N5arrow7compute23DictionaryEncodeOptions23DictionaryEncodeOptionsE20NullEncodingBehavior"></span><span id="arrow::compute::DictionaryEncodeOptions::DictionaryEncodeOptions__NullEncodingBehavior"></span><span class="target" id="classarrow_1_1compute_1_1_dictionary_encode_options_1a0da976cc5ff9e9469a371729fcfaa4da"></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">DictionaryEncodeOptions</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4N5arrow7compute23DictionaryEncodeOptions20NullEncodingBehaviorE" title="arrow::compute::DictionaryEncodeOptions::NullEncodingBehavior"><span class="n"><span class="pre">NullEncodingBehavior</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">null_encoding</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow7compute23DictionaryEncodeOptions20NullEncodingBehavior4MASKE" title="arrow::compute::DictionaryEncodeOptions::MASK"><span class="n"><span class="pre">MASK</span></span></a><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute23DictionaryEncodeOptions23DictionaryEncodeOptionsE20NullEncodingBehavior" 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="_CPPv4N5arrow7compute23DictionaryEncodeOptions22null_encoding_behaviorE"> |
| <span id="_CPPv3N5arrow7compute23DictionaryEncodeOptions22null_encoding_behaviorE"></span><span id="_CPPv2N5arrow7compute23DictionaryEncodeOptions22null_encoding_behaviorE"></span><span id="arrow::compute::DictionaryEncodeOptions::null_encoding_behavior__NullEncodingBehavior"></span><span class="target" id="classarrow_1_1compute_1_1_dictionary_encode_options_1a3016f707c86dcd3cfef55e3e87443284"></span><a class="reference internal" href="#_CPPv4N5arrow7compute23DictionaryEncodeOptions20NullEncodingBehaviorE" title="arrow::compute::DictionaryEncodeOptions::NullEncodingBehavior"><span class="n"><span class="pre">NullEncodingBehavior</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">null_encoding_behavior</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow7compute23DictionaryEncodeOptions20NullEncodingBehavior4MASKE" title="arrow::compute::DictionaryEncodeOptions::MASK"><span class="n"><span class="pre">MASK</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute23DictionaryEncodeOptions22null_encoding_behaviorE" 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="_CPPv4N5arrow7compute23DictionaryEncodeOptions8DefaultsEv"> |
| <span id="_CPPv3N5arrow7compute23DictionaryEncodeOptions8DefaultsEv"></span><span id="_CPPv2N5arrow7compute23DictionaryEncodeOptions8DefaultsEv"></span><span id="arrow::compute::DictionaryEncodeOptions::Defaults"></span><span class="target" id="classarrow_1_1compute_1_1_dictionary_encode_options_1aacc7f3ac957244654ab6cdc683cb146e"></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="#_CPPv4N5arrow7compute23DictionaryEncodeOptionsE" title="arrow::compute::DictionaryEncodeOptions"><span class="n"><span class="pre">DictionaryEncodeOptions</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="#_CPPv4N5arrow7compute23DictionaryEncodeOptions8DefaultsEv" 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-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute23DictionaryEncodeOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute23DictionaryEncodeOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute23DictionaryEncodeOptions9kTypeNameE"></span><span id="arrow::compute::DictionaryEncodeOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_dictionary_encode_options_1a48007cdbc41cfb5c25974dd9c4417376"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"DictionaryEncodeOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute23DictionaryEncodeOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute19RunEndEncodeOptionsE"> |
| <span id="_CPPv3N5arrow7compute19RunEndEncodeOptionsE"></span><span id="_CPPv2N5arrow7compute19RunEndEncodeOptionsE"></span><span id="arrow::compute::RunEndEncodeOptions"></span><span class="target" id="classarrow_1_1compute_1_1_run_end_encode_options"></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">RunEndEncodeOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute19RunEndEncodeOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_vector.h></em></div> |
| <p>Options for the run-end encode function. </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="_CPPv4N5arrow7compute19RunEndEncodeOptions19RunEndEncodeOptionsENSt10shared_ptrI8DataTypeEE"> |
| <span id="_CPPv3N5arrow7compute19RunEndEncodeOptions19RunEndEncodeOptionsENSt10shared_ptrI8DataTypeEE"></span><span id="_CPPv2N5arrow7compute19RunEndEncodeOptions19RunEndEncodeOptionsENSt10shared_ptrI8DataTypeEE"></span><span id="arrow::compute::RunEndEncodeOptions::RunEndEncodeOptions__std::shared_ptr:DataType:"></span><span class="target" id="classarrow_1_1compute_1_1_run_end_encode_options_1ad839486bb47ff6e81bfe9d2d0c12ce5f"></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">RunEndEncodeOptions</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="datatype.html#_CPPv4N5arrow8DataTypeE" title="arrow::DataType"><span class="n"><span class="pre">DataType</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">run_end_type</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><a class="reference internal" href="datatype.html#_CPPv45int32v" title="int32"><span class="n"><span class="pre">int32</span></span></a><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="#_CPPv4N5arrow7compute19RunEndEncodeOptions19RunEndEncodeOptionsENSt10shared_ptrI8DataTypeEE" 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="_CPPv4N5arrow7compute19RunEndEncodeOptions12run_end_typeE"> |
| <span id="_CPPv3N5arrow7compute19RunEndEncodeOptions12run_end_typeE"></span><span id="_CPPv2N5arrow7compute19RunEndEncodeOptions12run_end_typeE"></span><span id="arrow::compute::RunEndEncodeOptions::run_end_type__std::shared_ptr:DataType:"></span><span class="target" id="classarrow_1_1compute_1_1_run_end_encode_options_1a71e2e1c05423597c38007691ab7fc059"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow8DataTypeE" title="arrow::DataType"><span class="n"><span class="pre">DataType</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">run_end_type</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute19RunEndEncodeOptions12run_end_typeE" 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="_CPPv4N5arrow7compute19RunEndEncodeOptions8DefaultsEv"> |
| <span id="_CPPv3N5arrow7compute19RunEndEncodeOptions8DefaultsEv"></span><span id="_CPPv2N5arrow7compute19RunEndEncodeOptions8DefaultsEv"></span><span id="arrow::compute::RunEndEncodeOptions::Defaults"></span><span class="target" id="classarrow_1_1compute_1_1_run_end_encode_options_1a4393da94de4458923f415077588cbc75"></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="#_CPPv4N5arrow7compute19RunEndEncodeOptionsE" title="arrow::compute::RunEndEncodeOptions"><span class="n"><span class="pre">RunEndEncodeOptions</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="#_CPPv4N5arrow7compute19RunEndEncodeOptions8DefaultsEv" 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-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute19RunEndEncodeOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute19RunEndEncodeOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute19RunEndEncodeOptions9kTypeNameE"></span><span id="arrow::compute::RunEndEncodeOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_run_end_encode_options_1ad83b48d34c8d62a6e8108e61c2326803"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"RunEndEncodeOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute19RunEndEncodeOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16ArraySortOptionsE"> |
| <span id="_CPPv3N5arrow7compute16ArraySortOptionsE"></span><span id="_CPPv2N5arrow7compute16ArraySortOptionsE"></span><span id="arrow::compute::ArraySortOptions"></span><span class="target" id="classarrow_1_1compute_1_1_array_sort_options"></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">ArraySortOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute16ArraySortOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_vector.h></em></div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16ArraySortOptions16ArraySortOptionsE9SortOrder13NullPlacement"> |
| <span id="_CPPv3N5arrow7compute16ArraySortOptions16ArraySortOptionsE9SortOrder13NullPlacement"></span><span id="_CPPv2N5arrow7compute16ArraySortOptions16ArraySortOptionsE9SortOrder13NullPlacement"></span><span id="arrow::compute::ArraySortOptions::ArraySortOptions__SortOrder.NullPlacement"></span><span class="target" id="classarrow_1_1compute_1_1_array_sort_options_1adb4e6262774033830868785b84a89926"></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">ArraySortOptions</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">SortOrder</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">order</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">SortOrder</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">Ascending</span></span>, <span class="n"><span class="pre">NullPlacement</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">null_placement</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">NullPlacement</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">AtEnd</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute16ArraySortOptions16ArraySortOptionsE9SortOrder13NullPlacement" 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="_CPPv4N5arrow7compute16ArraySortOptions5orderE"> |
| <span id="_CPPv3N5arrow7compute16ArraySortOptions5orderE"></span><span id="_CPPv2N5arrow7compute16ArraySortOptions5orderE"></span><span id="arrow::compute::ArraySortOptions::order__SortOrder"></span><span class="target" id="classarrow_1_1compute_1_1_array_sort_options_1a815ec5b4a01e6d4d9fe52ca7efa4960c"></span><span class="n"><span class="pre">SortOrder</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">order</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute16ArraySortOptions5orderE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Sorting order. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16ArraySortOptions14null_placementE"> |
| <span id="_CPPv3N5arrow7compute16ArraySortOptions14null_placementE"></span><span id="_CPPv2N5arrow7compute16ArraySortOptions14null_placementE"></span><span id="arrow::compute::ArraySortOptions::null_placement__NullPlacement"></span><span class="target" id="classarrow_1_1compute_1_1_array_sort_options_1ae2669acd4efce6aab80b975d4ac63a00"></span><span class="n"><span class="pre">NullPlacement</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">null_placement</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute16ArraySortOptions14null_placementE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Whether nulls and NaNs are placed at the start or at the end. </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="_CPPv4N5arrow7compute16ArraySortOptions8DefaultsEv"> |
| <span id="_CPPv3N5arrow7compute16ArraySortOptions8DefaultsEv"></span><span id="_CPPv2N5arrow7compute16ArraySortOptions8DefaultsEv"></span><span id="arrow::compute::ArraySortOptions::Defaults"></span><span class="target" id="classarrow_1_1compute_1_1_array_sort_options_1a900a4aba27fffa7d35af54fa0c19dfb0"></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="#_CPPv4N5arrow7compute16ArraySortOptionsE" title="arrow::compute::ArraySortOptions"><span class="n"><span class="pre">ArraySortOptions</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="#_CPPv4N5arrow7compute16ArraySortOptions8DefaultsEv" 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-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute16ArraySortOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute16ArraySortOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute16ArraySortOptions9kTypeNameE"></span><span id="arrow::compute::ArraySortOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_array_sort_options_1a49397da8e4fc095af2671931440bca3f"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"ArraySortOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute16ArraySortOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11SortOptionsE"> |
| <span id="_CPPv3N5arrow7compute11SortOptionsE"></span><span id="_CPPv2N5arrow7compute11SortOptionsE"></span><span id="arrow::compute::SortOptions"></span><span class="target" id="classarrow_1_1compute_1_1_sort_options"></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">SortOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute11SortOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_vector.h></em></div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11SortOptions11SortOptionsENSt6vectorI7SortKeyEE13NullPlacement"> |
| <span id="_CPPv3N5arrow7compute11SortOptions11SortOptionsENSt6vectorI7SortKeyEE13NullPlacement"></span><span id="_CPPv2N5arrow7compute11SortOptions11SortOptionsENSt6vectorI7SortKeyEE13NullPlacement"></span><span id="arrow::compute::SortOptions::SortOptions__std::vector:SortKey:.NullPlacement"></span><span class="target" id="classarrow_1_1compute_1_1_sort_options_1a057bb9378c2b5a2cafa56d1fcf6fa24b"></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">SortOptions</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="n"><span class="pre">SortKey</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">sort_keys</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">NullPlacement</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">null_placement</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">NullPlacement</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">AtEnd</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute11SortOptions11SortOptionsENSt6vectorI7SortKeyEE13NullPlacement" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11SortOptions11SortOptionsERK8Ordering"> |
| <span id="_CPPv3N5arrow7compute11SortOptions11SortOptionsERK8Ordering"></span><span id="_CPPv2N5arrow7compute11SortOptions11SortOptionsERK8Ordering"></span><span id="arrow::compute::SortOptions::SortOptions__OrderingCR"></span><span class="target" id="classarrow_1_1compute_1_1_sort_options_1ad8f6b331e28385c05aaff1cdf1287dc6"></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">SortOptions</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">Ordering</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">ordering</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute11SortOptions11SortOptionsERK8Ordering" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NO5arrow7compute11SortOptions10AsOrderingEv"> |
| <span id="_CPPv3NO5arrow7compute11SortOptions10AsOrderingEv"></span><span id="_CPPv2NO5arrow7compute11SortOptions10AsOrderingEv"></span><span id="arrow::compute::SortOptions::AsOrderingO"></span><span class="target" id="classarrow_1_1compute_1_1_sort_options_1a974a761fb34d22dda6e9d267ebbd207c"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="n"><span class="pre">Ordering</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AsOrdering</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><a class="headerlink" href="#_CPPv4NO5arrow7compute11SortOptions10AsOrderingEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Convenience constructor to create an ordering from <a class="reference internal" href="#classarrow_1_1compute_1_1_sort_options"><span class="std std-ref">SortOptions</span></a>. </p> |
| <p>Note: Both classes contain the exact same information. However, sort_options should only be used in a “function options” context while Ordering is used more generally. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NKR5arrow7compute11SortOptions10AsOrderingEv"> |
| <span id="_CPPv3NKR5arrow7compute11SortOptions10AsOrderingEv"></span><span id="_CPPv2NKR5arrow7compute11SortOptions10AsOrderingEv"></span><span id="arrow::compute::SortOptions::AsOrderingCR"></span><span class="target" id="classarrow_1_1compute_1_1_sort_options_1ad7d24af0ba6c9c2cc4294414146f0cfb"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="n"><span class="pre">Ordering</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AsOrdering</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="#_CPPv4NKR5arrow7compute11SortOptions10AsOrderingEv" 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="_CPPv4N5arrow7compute11SortOptions9sort_keysE"> |
| <span id="_CPPv3N5arrow7compute11SortOptions9sort_keysE"></span><span id="_CPPv2N5arrow7compute11SortOptions9sort_keysE"></span><span id="arrow::compute::SortOptions::sort_keys__std::vector:SortKey:"></span><span class="target" id="classarrow_1_1compute_1_1_sort_options_1ab628d7bde76de57f925a31021ba2defe"></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">SortKey</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">sort_keys</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11SortOptions9sort_keysE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Column key(s) to order by and how to order by these sort keys. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11SortOptions14null_placementE"> |
| <span id="_CPPv3N5arrow7compute11SortOptions14null_placementE"></span><span id="_CPPv2N5arrow7compute11SortOptions14null_placementE"></span><span id="arrow::compute::SortOptions::null_placement__NullPlacement"></span><span class="target" id="classarrow_1_1compute_1_1_sort_options_1a5e4144128a1d14f406c6a0e425a98806"></span><span class="n"><span class="pre">NullPlacement</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">null_placement</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11SortOptions14null_placementE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Whether nulls and NaNs are placed at the start or at the end. </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="_CPPv4N5arrow7compute11SortOptions8DefaultsEv"> |
| <span id="_CPPv3N5arrow7compute11SortOptions8DefaultsEv"></span><span id="_CPPv2N5arrow7compute11SortOptions8DefaultsEv"></span><span id="arrow::compute::SortOptions::Defaults"></span><span class="target" id="classarrow_1_1compute_1_1_sort_options_1a02f5721ed6ff1ed7aa219c89e8ce9ad5"></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="#_CPPv4N5arrow7compute11SortOptionsE" title="arrow::compute::SortOptions"><span class="n"><span class="pre">SortOptions</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="#_CPPv4N5arrow7compute11SortOptions8DefaultsEv" 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-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11SortOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute11SortOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute11SortOptions9kTypeNameE"></span><span id="arrow::compute::SortOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_sort_options_1a6d859921617e4a607a68b6c5f76de50d"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"SortOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11SortOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute14SelectKOptionsE"> |
| <span id="_CPPv3N5arrow7compute14SelectKOptionsE"></span><span id="_CPPv2N5arrow7compute14SelectKOptionsE"></span><span id="arrow::compute::SelectKOptions"></span><span class="target" id="classarrow_1_1compute_1_1_select_k_options"></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">SelectKOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute14SelectKOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_vector.h></em></div> |
| <p>SelectK options. </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="_CPPv4N5arrow7compute14SelectKOptions14SelectKOptionsE7int64_tNSt6vectorI7SortKeyEE"> |
| <span id="_CPPv3N5arrow7compute14SelectKOptions14SelectKOptionsE7int64_tNSt6vectorI7SortKeyEE"></span><span id="_CPPv2N5arrow7compute14SelectKOptions14SelectKOptionsE7int64_tNSt6vectorI7SortKeyEE"></span><span id="arrow::compute::SelectKOptions::SelectKOptions__int64_t.std::vector:SortKey:"></span><span class="target" id="classarrow_1_1compute_1_1_select_k_options_1a637d8a46bdcb970ae390159494001e96"></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">SelectKOptions</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">k</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="o"><span class="pre">-</span></span><span class="m"><span class="pre">1</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">SortKey</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">sort_keys</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="#_CPPv4N5arrow7compute14SelectKOptions14SelectKOptionsE7int64_tNSt6vectorI7SortKeyEE" 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="_CPPv4N5arrow7compute14SelectKOptions1kE"> |
| <span id="_CPPv3N5arrow7compute14SelectKOptions1kE"></span><span id="_CPPv2N5arrow7compute14SelectKOptions1kE"></span><span id="arrow::compute::SelectKOptions::k__int64_t"></span><span class="target" id="classarrow_1_1compute_1_1_select_k_options_1aac4824f3db55a0569ef6885d5201a696"></span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">k</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute14SelectKOptions1kE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The number of <code class="docutils literal notranslate"><span class="pre">k</span></code> elements to keep. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute14SelectKOptions9sort_keysE"> |
| <span id="_CPPv3N5arrow7compute14SelectKOptions9sort_keysE"></span><span id="_CPPv2N5arrow7compute14SelectKOptions9sort_keysE"></span><span id="arrow::compute::SelectKOptions::sort_keys__std::vector:SortKey:"></span><span class="target" id="classarrow_1_1compute_1_1_select_k_options_1a30389cd6d41aa9b2523fb0afb3cc2528"></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">SortKey</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">sort_keys</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute14SelectKOptions9sort_keysE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Column key(s) to order by and how to order by these sort keys. </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="_CPPv4N5arrow7compute14SelectKOptions8DefaultsEv"> |
| <span id="_CPPv3N5arrow7compute14SelectKOptions8DefaultsEv"></span><span id="_CPPv2N5arrow7compute14SelectKOptions8DefaultsEv"></span><span id="arrow::compute::SelectKOptions::Defaults"></span><span class="target" id="classarrow_1_1compute_1_1_select_k_options_1a278c05dad88f75673e07d5e232f38bf8"></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="#_CPPv4N5arrow7compute14SelectKOptionsE" title="arrow::compute::SelectKOptions"><span class="n"><span class="pre">SelectKOptions</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="#_CPPv4N5arrow7compute14SelectKOptions8DefaultsEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute14SelectKOptions11TopKDefaultE7int64_tNSt6vectorINSt6stringEEE"> |
| <span id="_CPPv3N5arrow7compute14SelectKOptions11TopKDefaultE7int64_tNSt6vectorINSt6stringEEE"></span><span id="_CPPv2N5arrow7compute14SelectKOptions11TopKDefaultE7int64_tNSt6vectorINSt6stringEEE"></span><span id="arrow::compute::SelectKOptions::TopKDefault__int64_t.std::vector:ss:"></span><span class="target" id="classarrow_1_1compute_1_1_select_k_options_1a6a69b88e664047b994291eb65e9160e7"></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="#_CPPv4N5arrow7compute14SelectKOptionsE" title="arrow::compute::SelectKOptions"><span class="n"><span class="pre">SelectKOptions</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">TopKDefault</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">k</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">key_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="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute14SelectKOptions11TopKDefaultE7int64_tNSt6vectorINSt6stringEEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute14SelectKOptions14BottomKDefaultE7int64_tNSt6vectorINSt6stringEEE"> |
| <span id="_CPPv3N5arrow7compute14SelectKOptions14BottomKDefaultE7int64_tNSt6vectorINSt6stringEEE"></span><span id="_CPPv2N5arrow7compute14SelectKOptions14BottomKDefaultE7int64_tNSt6vectorINSt6stringEEE"></span><span id="arrow::compute::SelectKOptions::BottomKDefault__int64_t.std::vector:ss:"></span><span class="target" id="classarrow_1_1compute_1_1_select_k_options_1aa06dfe8eae23e5c5ffc590c030cadbf2"></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="#_CPPv4N5arrow7compute14SelectKOptionsE" title="arrow::compute::SelectKOptions"><span class="n"><span class="pre">SelectKOptions</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">BottomKDefault</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">k</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">key_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="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute14SelectKOptions14BottomKDefaultE7int64_tNSt6vectorINSt6stringEEE" 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-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute14SelectKOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute14SelectKOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute14SelectKOptions9kTypeNameE"></span><span id="arrow::compute::SelectKOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_select_k_options_1a43af86362a62c7ed2b7befc9fed2cdca"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"SelectKOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute14SelectKOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11RankOptionsE"> |
| <span id="_CPPv3N5arrow7compute11RankOptionsE"></span><span id="_CPPv2N5arrow7compute11RankOptionsE"></span><span id="arrow::compute::RankOptions"></span><span class="target" id="classarrow_1_1compute_1_1_rank_options"></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">RankOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute11RankOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_vector.h></em></div> |
| <p>Rank options. </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 enum"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11RankOptions10TiebreakerE"> |
| <span id="_CPPv3N5arrow7compute11RankOptions10TiebreakerE"></span><span id="_CPPv2N5arrow7compute11RankOptions10TiebreakerE"></span><span class="target" id="classarrow_1_1compute_1_1_rank_options_1abb0d5b3199cf1b371d890b9b565ebd39"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Tiebreaker</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11RankOptions10TiebreakerE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Configure how ties between equal values are handled. </p> |
| <p><em>Values:</em></p> |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11RankOptions10Tiebreaker3MinE"> |
| <span id="_CPPv3N5arrow7compute11RankOptions10Tiebreaker3MinE"></span><span id="_CPPv2N5arrow7compute11RankOptions10Tiebreaker3MinE"></span><span class="target" id="classarrow_1_1compute_1_1_rank_options_1abb0d5b3199cf1b371d890b9b565ebd39a118179311e81eb4c6828e2e977e3da23"></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">Min</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11RankOptions10Tiebreaker3MinE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Ties get the smallest possible rank in sorted order. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11RankOptions10Tiebreaker3MaxE"> |
| <span id="_CPPv3N5arrow7compute11RankOptions10Tiebreaker3MaxE"></span><span id="_CPPv2N5arrow7compute11RankOptions10Tiebreaker3MaxE"></span><span class="target" id="classarrow_1_1compute_1_1_rank_options_1abb0d5b3199cf1b371d890b9b565ebd39a94afdd8a6a3291b714787d0528663dff"></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</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11RankOptions10Tiebreaker3MaxE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Ties get the largest possible rank in sorted order. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11RankOptions10Tiebreaker5FirstE"> |
| <span id="_CPPv3N5arrow7compute11RankOptions10Tiebreaker5FirstE"></span><span id="_CPPv2N5arrow7compute11RankOptions10Tiebreaker5FirstE"></span><span class="target" id="classarrow_1_1compute_1_1_rank_options_1abb0d5b3199cf1b371d890b9b565ebd39a3af0a7f0809cebe1bb3fbcdc7700ff65"></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">First</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11RankOptions10Tiebreaker5FirstE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Ranks are assigned in order of when ties appear in the input. </p> |
| <p>This ensures the ranks are a stable permutation of the input. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11RankOptions10Tiebreaker5DenseE"> |
| <span id="_CPPv3N5arrow7compute11RankOptions10Tiebreaker5DenseE"></span><span id="_CPPv2N5arrow7compute11RankOptions10Tiebreaker5DenseE"></span><span class="target" id="classarrow_1_1compute_1_1_rank_options_1abb0d5b3199cf1b371d890b9b565ebd39a63915b295526f92def2620fdbfd42f58"></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</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11RankOptions10Tiebreaker5DenseE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The ranks span a dense [1, M] interval where M is the number of distinct values in the input. </p> |
| </dd></dl> |
| |
| </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="_CPPv4N5arrow7compute11RankOptions11RankOptionsENSt6vectorI7SortKeyEE13NullPlacement10Tiebreaker"> |
| <span id="_CPPv3N5arrow7compute11RankOptions11RankOptionsENSt6vectorI7SortKeyEE13NullPlacement10Tiebreaker"></span><span id="_CPPv2N5arrow7compute11RankOptions11RankOptionsENSt6vectorI7SortKeyEE13NullPlacement10Tiebreaker"></span><span id="arrow::compute::RankOptions::RankOptions__std::vector:SortKey:.NullPlacement.Tiebreaker"></span><span class="target" id="classarrow_1_1compute_1_1_rank_options_1a860fd96e7a0e2c88699d0b6e18080621"></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">RankOptions</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="n"><span class="pre">SortKey</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">sort_keys</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">NullPlacement</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">null_placement</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">NullPlacement</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">AtEnd</span></span>, <a class="reference internal" href="#_CPPv4N5arrow7compute11RankOptions10TiebreakerE" title="arrow::compute::RankOptions::Tiebreaker"><span class="n"><span class="pre">Tiebreaker</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">tiebreaker</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow7compute11RankOptions11RankOptionsENSt6vectorI7SortKeyEE13NullPlacement10Tiebreaker" title="arrow::compute::RankOptions::RankOptions"><span class="n"><span class="pre">RankOptions</span></span></a><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">First</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute11RankOptions11RankOptionsENSt6vectorI7SortKeyEE13NullPlacement10Tiebreaker" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11RankOptions11RankOptionsE9SortOrder13NullPlacement10Tiebreaker"> |
| <span id="_CPPv3N5arrow7compute11RankOptions11RankOptionsE9SortOrder13NullPlacement10Tiebreaker"></span><span id="_CPPv2N5arrow7compute11RankOptions11RankOptionsE9SortOrder13NullPlacement10Tiebreaker"></span><span id="arrow::compute::RankOptions::RankOptions__SortOrder.NullPlacement.Tiebreaker"></span><span class="target" id="classarrow_1_1compute_1_1_rank_options_1ab664b4ee57ec8780f1e93d3fa1b3146f"></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">RankOptions</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">SortOrder</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">order</span></span>, <span class="n"><span class="pre">NullPlacement</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">null_placement</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">NullPlacement</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">AtEnd</span></span>, <a class="reference internal" href="#_CPPv4N5arrow7compute11RankOptions10TiebreakerE" title="arrow::compute::RankOptions::Tiebreaker"><span class="n"><span class="pre">Tiebreaker</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">tiebreaker</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow7compute11RankOptions11RankOptionsE9SortOrder13NullPlacement10Tiebreaker" title="arrow::compute::RankOptions::RankOptions"><span class="n"><span class="pre">RankOptions</span></span></a><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">First</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute11RankOptions11RankOptionsE9SortOrder13NullPlacement10Tiebreaker" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Convenience constructor for array inputs. </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="_CPPv4N5arrow7compute11RankOptions9sort_keysE"> |
| <span id="_CPPv3N5arrow7compute11RankOptions9sort_keysE"></span><span id="_CPPv2N5arrow7compute11RankOptions9sort_keysE"></span><span id="arrow::compute::RankOptions::sort_keys__std::vector:SortKey:"></span><span class="target" id="classarrow_1_1compute_1_1_rank_options_1af000eaf924b50bc861358e9d031c090d"></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">SortKey</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">sort_keys</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11RankOptions9sort_keysE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Column key(s) to order by and how to order by these sort keys. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11RankOptions14null_placementE"> |
| <span id="_CPPv3N5arrow7compute11RankOptions14null_placementE"></span><span id="_CPPv2N5arrow7compute11RankOptions14null_placementE"></span><span id="arrow::compute::RankOptions::null_placement__NullPlacement"></span><span class="target" id="classarrow_1_1compute_1_1_rank_options_1a4991934cef6efbfa561993836ccc5fda"></span><span class="n"><span class="pre">NullPlacement</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">null_placement</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11RankOptions14null_placementE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Whether nulls and NaNs are placed at the start or at the end. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11RankOptions10tiebreakerE"> |
| <span id="_CPPv3N5arrow7compute11RankOptions10tiebreakerE"></span><span id="_CPPv2N5arrow7compute11RankOptions10tiebreakerE"></span><span id="arrow::compute::RankOptions::tiebreaker__Tiebreaker"></span><span class="target" id="classarrow_1_1compute_1_1_rank_options_1ae1c68305eee355611828940712752df8"></span><a class="reference internal" href="#_CPPv4N5arrow7compute11RankOptions10TiebreakerE" title="arrow::compute::RankOptions::Tiebreaker"><span class="n"><span class="pre">Tiebreaker</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">tiebreaker</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11RankOptions10tiebreakerE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Tiebreaker for dealing with equal values in ranks. </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="_CPPv4N5arrow7compute11RankOptions8DefaultsEv"> |
| <span id="_CPPv3N5arrow7compute11RankOptions8DefaultsEv"></span><span id="_CPPv2N5arrow7compute11RankOptions8DefaultsEv"></span><span id="arrow::compute::RankOptions::Defaults"></span><span class="target" id="classarrow_1_1compute_1_1_rank_options_1aa363f0396c980491b535018c8340e7fa"></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="#_CPPv4N5arrow7compute11RankOptionsE" title="arrow::compute::RankOptions"><span class="n"><span class="pre">RankOptions</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="#_CPPv4N5arrow7compute11RankOptions8DefaultsEv" 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-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11RankOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute11RankOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute11RankOptions9kTypeNameE"></span><span id="arrow::compute::RankOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_rank_options_1a58159df6ec1cc145cd4192b2485134a4"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"RankOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11RankOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute19PartitionNthOptionsE"> |
| <span id="_CPPv3N5arrow7compute19PartitionNthOptionsE"></span><span id="_CPPv2N5arrow7compute19PartitionNthOptionsE"></span><span id="arrow::compute::PartitionNthOptions"></span><span class="target" id="classarrow_1_1compute_1_1_partition_nth_options"></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">PartitionNthOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute19PartitionNthOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_vector.h></em></div> |
| <p>Partitioning options for NthToIndices. </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="_CPPv4N5arrow7compute19PartitionNthOptions19PartitionNthOptionsE7int64_t13NullPlacement"> |
| <span id="_CPPv3N5arrow7compute19PartitionNthOptions19PartitionNthOptionsE7int64_t13NullPlacement"></span><span id="_CPPv2N5arrow7compute19PartitionNthOptions19PartitionNthOptionsE7int64_t13NullPlacement"></span><span id="arrow::compute::PartitionNthOptions::PartitionNthOptions__int64_t.NullPlacement"></span><span class="target" id="classarrow_1_1compute_1_1_partition_nth_options_1aeb3f173b9cc30f99b53c3f4ed175e7f7"></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">PartitionNthOptions</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">pivot</span></span>, <span class="n"><span class="pre">NullPlacement</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">null_placement</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">NullPlacement</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">AtEnd</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute19PartitionNthOptions19PartitionNthOptionsE7int64_t13NullPlacement" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute19PartitionNthOptions19PartitionNthOptionsEv"> |
| <span id="_CPPv3N5arrow7compute19PartitionNthOptions19PartitionNthOptionsEv"></span><span id="_CPPv2N5arrow7compute19PartitionNthOptions19PartitionNthOptionsEv"></span><span id="arrow::compute::PartitionNthOptions::PartitionNthOptions"></span><span class="target" id="classarrow_1_1compute_1_1_partition_nth_options_1a70e9904d596194cc55a404e50a21a0c5"></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">PartitionNthOptions</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute19PartitionNthOptions19PartitionNthOptionsEv" 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="_CPPv4N5arrow7compute19PartitionNthOptions5pivotE"> |
| <span id="_CPPv3N5arrow7compute19PartitionNthOptions5pivotE"></span><span id="_CPPv2N5arrow7compute19PartitionNthOptions5pivotE"></span><span id="arrow::compute::PartitionNthOptions::pivot__int64_t"></span><span class="target" id="classarrow_1_1compute_1_1_partition_nth_options_1a0f4dc67990e19f8e497895155737fded"></span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">pivot</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute19PartitionNthOptions5pivotE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The index into the equivalent sorted array of the partition pivot element. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute19PartitionNthOptions14null_placementE"> |
| <span id="_CPPv3N5arrow7compute19PartitionNthOptions14null_placementE"></span><span id="_CPPv2N5arrow7compute19PartitionNthOptions14null_placementE"></span><span id="arrow::compute::PartitionNthOptions::null_placement__NullPlacement"></span><span class="target" id="classarrow_1_1compute_1_1_partition_nth_options_1afee8e5c8d5599022788430ffb3f11034"></span><span class="n"><span class="pre">NullPlacement</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">null_placement</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute19PartitionNthOptions14null_placementE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Whether nulls and NaNs are partitioned at the start or at the end. </p> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-static-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute19PartitionNthOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute19PartitionNthOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute19PartitionNthOptions9kTypeNameE"></span><span id="arrow::compute::PartitionNthOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_partition_nth_options_1a72dd0f16d6e27bce61d41be323affdd5"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"PartitionNthOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute19PartitionNthOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute17CumulativeOptionsE"> |
| <span id="_CPPv3N5arrow7compute17CumulativeOptionsE"></span><span id="_CPPv2N5arrow7compute17CumulativeOptionsE"></span><span id="arrow::compute::CumulativeOptions"></span><span class="target" id="classarrow_1_1compute_1_1_cumulative_options"></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">CumulativeOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute17CumulativeOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_vector.h></em></div> |
| <p>Options for cumulative functions. </p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>Also aliased as CumulativeSumOptions for backward compatibility </p> |
| </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="_CPPv4N5arrow7compute17CumulativeOptions17CumulativeOptionsEb"> |
| <span id="_CPPv3N5arrow7compute17CumulativeOptions17CumulativeOptionsEb"></span><span id="_CPPv2N5arrow7compute17CumulativeOptions17CumulativeOptionsEb"></span><span id="arrow::compute::CumulativeOptions::CumulativeOptions__b"></span><span class="target" id="classarrow_1_1compute_1_1_cumulative_options_1a76e01f82469c3fe58f9f2e36df39887c"></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">CumulativeOptions</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">skip_nulls</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="#_CPPv4N5arrow7compute17CumulativeOptions17CumulativeOptionsEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute17CumulativeOptions17CumulativeOptionsEdb"> |
| <span id="_CPPv3N5arrow7compute17CumulativeOptions17CumulativeOptionsEdb"></span><span id="_CPPv2N5arrow7compute17CumulativeOptions17CumulativeOptionsEdb"></span><span id="arrow::compute::CumulativeOptions::CumulativeOptions__double.b"></span><span class="target" id="classarrow_1_1compute_1_1_cumulative_options_1a580817fddd71fff3c7e746211909f7d6"></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">CumulativeOptions</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">double</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">start</span></span>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">skip_nulls</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="#_CPPv4N5arrow7compute17CumulativeOptions17CumulativeOptionsEdb" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute17CumulativeOptions17CumulativeOptionsENSt10shared_ptrI6ScalarEEb"> |
| <span id="_CPPv3N5arrow7compute17CumulativeOptions17CumulativeOptionsENSt10shared_ptrI6ScalarEEb"></span><span id="_CPPv2N5arrow7compute17CumulativeOptions17CumulativeOptionsENSt10shared_ptrI6ScalarEEb"></span><span id="arrow::compute::CumulativeOptions::CumulativeOptions__std::shared_ptr:Scalar:.b"></span><span class="target" id="classarrow_1_1compute_1_1_cumulative_options_1a5a1c47983d477abd6fe1bf2c2af9cadd"></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">CumulativeOptions</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="scalar.html#_CPPv4N5arrow6ScalarE" title="arrow::Scalar"><span class="n"><span class="pre">Scalar</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">start</span></span>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">skip_nulls</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="#_CPPv4N5arrow7compute17CumulativeOptions17CumulativeOptionsENSt10shared_ptrI6ScalarEEb" 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="_CPPv4N5arrow7compute17CumulativeOptions5startE"> |
| <span id="_CPPv3N5arrow7compute17CumulativeOptions5startE"></span><span id="_CPPv2N5arrow7compute17CumulativeOptions5startE"></span><span id="arrow::compute::CumulativeOptions::start__std::optional:std::shared_ptr:Scalar::"></span><span class="target" id="classarrow_1_1compute_1_1_cumulative_options_1a299865e08e9566ee8309159c2c1b3894"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="scalar.html#_CPPv4N5arrow6ScalarE" title="arrow::Scalar"><span class="n"><span class="pre">Scalar</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">start</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute17CumulativeOptions5startE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Optional starting value for cumulative operation computation, default depends on the operation and input type. </p> |
| <p><ul class="simple"> |
| <li><p>sum: 0</p></li> |
| <li><p>prod: 1</p></li> |
| <li><p>min: maximum of the input type</p></li> |
| <li><p>max: minimum of the input type</p></li> |
| <li><p>mean: start is ignored because it has no meaning for mean </p></li> |
| </ul> |
| </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute17CumulativeOptions10skip_nullsE"> |
| <span id="_CPPv3N5arrow7compute17CumulativeOptions10skip_nullsE"></span><span id="_CPPv2N5arrow7compute17CumulativeOptions10skip_nullsE"></span><span id="arrow::compute::CumulativeOptions::skip_nulls__b"></span><span class="target" id="classarrow_1_1compute_1_1_cumulative_options_1a6098caf073ed0462d7dec54605df3ce4"></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">skip_nulls</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="#_CPPv4N5arrow7compute17CumulativeOptions10skip_nullsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>If true, nulls in the input are ignored and produce a corresponding null output. </p> |
| <p>When false, the first null encountered is propagated through the remaining output. </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="_CPPv4N5arrow7compute17CumulativeOptions8DefaultsEv"> |
| <span id="_CPPv3N5arrow7compute17CumulativeOptions8DefaultsEv"></span><span id="_CPPv2N5arrow7compute17CumulativeOptions8DefaultsEv"></span><span id="arrow::compute::CumulativeOptions::Defaults"></span><span class="target" id="classarrow_1_1compute_1_1_cumulative_options_1afa56104c09cdd815481deb1ee0280455"></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="#_CPPv4N5arrow7compute17CumulativeOptionsE" title="arrow::compute::CumulativeOptions"><span class="n"><span class="pre">CumulativeOptions</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="#_CPPv4N5arrow7compute17CumulativeOptions8DefaultsEv" 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-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute17CumulativeOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute17CumulativeOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute17CumulativeOptions9kTypeNameE"></span><span id="arrow::compute::CumulativeOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_cumulative_options_1af1ea257a78790e0b8c6aa6d15a45ba97"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"CumulativeOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute17CumulativeOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute15PairwiseOptionsE"> |
| <span id="_CPPv3N5arrow7compute15PairwiseOptionsE"></span><span id="_CPPv2N5arrow7compute15PairwiseOptionsE"></span><span id="arrow::compute::PairwiseOptions"></span><span class="target" id="classarrow_1_1compute_1_1_pairwise_options"></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">PairwiseOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute15PairwiseOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_vector.h></em></div> |
| <p>Options for pairwise functions. </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="_CPPv4N5arrow7compute15PairwiseOptions15PairwiseOptionsE7int64_t"> |
| <span id="_CPPv3N5arrow7compute15PairwiseOptions15PairwiseOptionsE7int64_t"></span><span id="_CPPv2N5arrow7compute15PairwiseOptions15PairwiseOptionsE7int64_t"></span><span id="arrow::compute::PairwiseOptions::PairwiseOptions__int64_t"></span><span class="target" id="classarrow_1_1compute_1_1_pairwise_options_1a1474e75eaaeeefedeaab2bb71d8359ea"></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">PairwiseOptions</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">periods</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">1</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute15PairwiseOptions15PairwiseOptionsE7int64_t" 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="_CPPv4N5arrow7compute15PairwiseOptions7periodsE"> |
| <span id="_CPPv3N5arrow7compute15PairwiseOptions7periodsE"></span><span id="_CPPv2N5arrow7compute15PairwiseOptions7periodsE"></span><span id="arrow::compute::PairwiseOptions::periods__int64_t"></span><span class="target" id="classarrow_1_1compute_1_1_pairwise_options_1aa18e0e097611bdc7e78df6b373eed34b"></span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">periods</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">1</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute15PairwiseOptions7periodsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Periods to shift for applying the binary operation, accepts negative values. </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="_CPPv4N5arrow7compute15PairwiseOptions8DefaultsEv"> |
| <span id="_CPPv3N5arrow7compute15PairwiseOptions8DefaultsEv"></span><span id="_CPPv2N5arrow7compute15PairwiseOptions8DefaultsEv"></span><span id="arrow::compute::PairwiseOptions::Defaults"></span><span class="target" id="classarrow_1_1compute_1_1_pairwise_options_1a1bfbaa925acc60669b8b9275342cbd7d"></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="#_CPPv4N5arrow7compute15PairwiseOptionsE" title="arrow::compute::PairwiseOptions"><span class="n"><span class="pre">PairwiseOptions</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="#_CPPv4N5arrow7compute15PairwiseOptions8DefaultsEv" 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-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute15PairwiseOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute15PairwiseOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute15PairwiseOptions9kTypeNameE"></span><span id="arrow::compute::PairwiseOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_pairwise_options_1acb00ffc1cad4efbcf1276d22e7af80cc"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"PairwiseOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute15PairwiseOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute18ListFlattenOptionsE"> |
| <span id="_CPPv3N5arrow7compute18ListFlattenOptionsE"></span><span id="_CPPv2N5arrow7compute18ListFlattenOptionsE"></span><span id="arrow::compute::ListFlattenOptions"></span><span class="target" id="classarrow_1_1compute_1_1_list_flatten_options"></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">ListFlattenOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute18ListFlattenOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/api_vector.h></em></div> |
| <p>Options for list_flatten function. </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="_CPPv4N5arrow7compute18ListFlattenOptions18ListFlattenOptionsEb"> |
| <span id="_CPPv3N5arrow7compute18ListFlattenOptions18ListFlattenOptionsEb"></span><span id="_CPPv2N5arrow7compute18ListFlattenOptions18ListFlattenOptionsEb"></span><span id="arrow::compute::ListFlattenOptions::ListFlattenOptions__b"></span><span class="target" id="classarrow_1_1compute_1_1_list_flatten_options_1ab52c798a28cab891398df8648cfd8856"></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">ListFlattenOptions</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">recursive</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="#_CPPv4N5arrow7compute18ListFlattenOptions18ListFlattenOptionsEb" 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="_CPPv4N5arrow7compute18ListFlattenOptions9recursiveE"> |
| <span id="_CPPv3N5arrow7compute18ListFlattenOptions9recursiveE"></span><span id="_CPPv2N5arrow7compute18ListFlattenOptions9recursiveE"></span><span id="arrow::compute::ListFlattenOptions::recursive__b"></span><span class="target" id="classarrow_1_1compute_1_1_list_flatten_options_1aa6edcd30277819d3cee6aec512ea4343"></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">recursive</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="#_CPPv4N5arrow7compute18ListFlattenOptions9recursiveE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>If true, the list is flattened recursively until a non-list array is formed. </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="_CPPv4N5arrow7compute18ListFlattenOptions8DefaultsEv"> |
| <span id="_CPPv3N5arrow7compute18ListFlattenOptions8DefaultsEv"></span><span id="_CPPv2N5arrow7compute18ListFlattenOptions8DefaultsEv"></span><span id="arrow::compute::ListFlattenOptions::Defaults"></span><span class="target" id="classarrow_1_1compute_1_1_list_flatten_options_1ac151077b1703b7c642f41689d657e677"></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="#_CPPv4N5arrow7compute18ListFlattenOptionsE" title="arrow::compute::ListFlattenOptions"><span class="n"><span class="pre">ListFlattenOptions</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="#_CPPv4N5arrow7compute18ListFlattenOptions8DefaultsEv" 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-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute18ListFlattenOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute18ListFlattenOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute18ListFlattenOptions9kTypeNameE"></span><span id="arrow::compute::ListFlattenOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_list_flatten_options_1af10488d7fa8c612cd79b4cd2e008be6b"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"ListFlattenOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute18ListFlattenOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11CastOptionsE"> |
| <span id="_CPPv3N5arrow7compute11CastOptionsE"></span><span id="_CPPv2N5arrow7compute11CastOptionsE"></span><span id="arrow::compute::CastOptions"></span><span class="target" id="classarrow_1_1compute_1_1_cast_options"></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">CastOptions</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">compute</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow7compute15FunctionOptionsE" title="arrow::compute::FunctionOptions"><span class="n"><span class="pre">FunctionOptions</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7compute11CastOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/cast.h></em></div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11CastOptions11CastOptionsEb"> |
| <span id="_CPPv3N5arrow7compute11CastOptions11CastOptionsEb"></span><span id="_CPPv2N5arrow7compute11CastOptions11CastOptionsEb"></span><span id="arrow::compute::CastOptions::CastOptions__b"></span><span class="target" id="classarrow_1_1compute_1_1_cast_options_1a16d1ed2f20571de5ddd1ad1f2b3bc187"></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">CastOptions</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">safe</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="k"><span class="pre">true</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow7compute11CastOptions11CastOptionsEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow7compute11CastOptions7is_safeEv"> |
| <span id="_CPPv3NK5arrow7compute11CastOptions7is_safeEv"></span><span id="_CPPv2NK5arrow7compute11CastOptions7is_safeEv"></span><span id="arrow::compute::CastOptions::is_safeC"></span><span class="target" id="classarrow_1_1compute_1_1_cast_options_1abe579f629dfe47f217f434f360a7ecfd"></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_safe</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="#_CPPv4NK5arrow7compute11CastOptions7is_safeEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>true if the safety options all match <a class="reference internal" href="#classarrow_1_1compute_1_1_cast_options_1a5427171f579ad5e4050810de78a16801"><span class="std std-ref">CastOptions::Safe</span></a></p> |
| <p>Note, if this returns false it does not mean is_unsafe will return true </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow7compute11CastOptions9is_unsafeEv"> |
| <span id="_CPPv3NK5arrow7compute11CastOptions9is_unsafeEv"></span><span id="_CPPv2NK5arrow7compute11CastOptions9is_unsafeEv"></span><span id="arrow::compute::CastOptions::is_unsafeC"></span><span class="target" id="classarrow_1_1compute_1_1_cast_options_1a6b20e4477b2a6592b98cab2ed12020fc"></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_unsafe</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="#_CPPv4NK5arrow7compute11CastOptions9is_unsafeEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>true if the safety options all match <a class="reference internal" href="#classarrow_1_1compute_1_1_cast_options_1abae43e9457f960b37ae1fcac728aac93"><span class="std std-ref">CastOptions::Unsafe</span></a></p> |
| <p>Note, if this returns false it does not mean is_safe will return true </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="_CPPv4N5arrow7compute11CastOptions7to_typeE"> |
| <span id="_CPPv3N5arrow7compute11CastOptions7to_typeE"></span><span id="_CPPv2N5arrow7compute11CastOptions7to_typeE"></span><span id="arrow::compute::CastOptions::to_type__TypeHolder"></span><span class="target" id="classarrow_1_1compute_1_1_cast_options_1aed8297caed208e0bd289c67eec3b5472"></span><span class="n"><span class="pre">TypeHolder</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">to_type</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11CastOptions7to_typeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11CastOptions18allow_int_overflowE"> |
| <span id="_CPPv3N5arrow7compute11CastOptions18allow_int_overflowE"></span><span id="_CPPv2N5arrow7compute11CastOptions18allow_int_overflowE"></span><span id="arrow::compute::CastOptions::allow_int_overflow__b"></span><span class="target" id="classarrow_1_1compute_1_1_cast_options_1acbb8da5a5aeecb1a89392a5dba94ecb7"></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">allow_int_overflow</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11CastOptions18allow_int_overflowE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11CastOptions19allow_time_truncateE"> |
| <span id="_CPPv3N5arrow7compute11CastOptions19allow_time_truncateE"></span><span id="_CPPv2N5arrow7compute11CastOptions19allow_time_truncateE"></span><span id="arrow::compute::CastOptions::allow_time_truncate__b"></span><span class="target" id="classarrow_1_1compute_1_1_cast_options_1ae7afd064112db4f0d91dd48ed2b567fd"></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">allow_time_truncate</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11CastOptions19allow_time_truncateE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11CastOptions19allow_time_overflowE"> |
| <span id="_CPPv3N5arrow7compute11CastOptions19allow_time_overflowE"></span><span id="_CPPv2N5arrow7compute11CastOptions19allow_time_overflowE"></span><span id="arrow::compute::CastOptions::allow_time_overflow__b"></span><span class="target" id="classarrow_1_1compute_1_1_cast_options_1a03a64dd62fe1f90c245134c66ad6f089"></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">allow_time_overflow</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11CastOptions19allow_time_overflowE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11CastOptions22allow_decimal_truncateE"> |
| <span id="_CPPv3N5arrow7compute11CastOptions22allow_decimal_truncateE"></span><span id="_CPPv2N5arrow7compute11CastOptions22allow_decimal_truncateE"></span><span id="arrow::compute::CastOptions::allow_decimal_truncate__b"></span><span class="target" id="classarrow_1_1compute_1_1_cast_options_1a630eca79ef24e32b93b4e193b4693db8"></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">allow_decimal_truncate</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11CastOptions22allow_decimal_truncateE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11CastOptions20allow_float_truncateE"> |
| <span id="_CPPv3N5arrow7compute11CastOptions20allow_float_truncateE"></span><span id="_CPPv2N5arrow7compute11CastOptions20allow_float_truncateE"></span><span id="arrow::compute::CastOptions::allow_float_truncate__b"></span><span class="target" id="classarrow_1_1compute_1_1_cast_options_1a043f54fcda9eb104c586d24787082aab"></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">allow_float_truncate</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11CastOptions20allow_float_truncateE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11CastOptions18allow_invalid_utf8E"> |
| <span id="_CPPv3N5arrow7compute11CastOptions18allow_invalid_utf8E"></span><span id="_CPPv2N5arrow7compute11CastOptions18allow_invalid_utf8E"></span><span id="arrow::compute::CastOptions::allow_invalid_utf8__b"></span><span class="target" id="classarrow_1_1compute_1_1_cast_options_1ac2da4663a6bcafe30a98fe0d853319ac"></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">allow_invalid_utf8</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11CastOptions18allow_invalid_utf8E" 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="_CPPv4N5arrow7compute11CastOptions4SafeE10TypeHolder"> |
| <span id="_CPPv3N5arrow7compute11CastOptions4SafeE10TypeHolder"></span><span id="_CPPv2N5arrow7compute11CastOptions4SafeE10TypeHolder"></span><span id="arrow::compute::CastOptions::Safe__TypeHolder"></span><span class="target" id="classarrow_1_1compute_1_1_cast_options_1a5427171f579ad5e4050810de78a16801"></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="#_CPPv4N5arrow7compute11CastOptionsE" title="arrow::compute::CastOptions"><span class="n"><span class="pre">CastOptions</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Safe</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">TypeHolder</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">to_type</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="#_CPPv4N5arrow7compute11CastOptions4SafeE10TypeHolder" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11CastOptions6UnsafeE10TypeHolder"> |
| <span id="_CPPv3N5arrow7compute11CastOptions6UnsafeE10TypeHolder"></span><span id="_CPPv2N5arrow7compute11CastOptions6UnsafeE10TypeHolder"></span><span id="arrow::compute::CastOptions::Unsafe__TypeHolder"></span><span class="target" id="classarrow_1_1compute_1_1_cast_options_1abae43e9457f960b37ae1fcac728aac93"></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="#_CPPv4N5arrow7compute11CastOptionsE" title="arrow::compute::CastOptions"><span class="n"><span class="pre">CastOptions</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Unsafe</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">TypeHolder</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">to_type</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="#_CPPv4N5arrow7compute11CastOptions6UnsafeE10TypeHolder" 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-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute11CastOptions9kTypeNameE"> |
| <span id="_CPPv3N5arrow7compute11CastOptions9kTypeNameE"></span><span id="_CPPv2N5arrow7compute11CastOptions9kTypeNameE"></span><span id="arrow::compute::CastOptions::kTypeName__cCA"></span><span class="target" id="classarrow_1_1compute_1_1_cast_options_1abb411ab7a18212730ab802204e711c87"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kTypeName</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">"CastOptions"</span></span><a class="headerlink" href="#_CPPv4N5arrow7compute11CastOptions9kTypeNameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| </section> |
| <section id="compute-expressions"> |
| <h2>Compute Expressions<a class="headerlink" href="#compute-expressions" title="Permalink to this heading">#</a></h2> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4eqRK10ExpressionRK10Expression"> |
| <span id="_CPPv3eqRK10ExpressionRK10Expression"></span><span id="_CPPv2eqRK10ExpressionRK10Expression"></span><span id="eq-operator__ExpressionCR.ExpressionCR"></span><span class="target" id="group__expression-core_1ga062ee6503655b2eaaff5c44e7852b90d"></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><span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">l</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">r</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4eqRK10ExpressionRK10Expression" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4neRK10ExpressionRK10Expression"> |
| <span id="_CPPv3neRK10ExpressionRK10Expression"></span><span id="_CPPv2neRK10ExpressionRK10Expression"></span><span id="neq-operator__ExpressionCR.ExpressionCR"></span><span class="target" id="group__expression-core_1ga52fb80974df09bfa7932a268942ed902"></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><span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">l</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">r</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4neRK10ExpressionRK10Expression" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv47PrintToRK10ExpressionPNSt7ostreamE"> |
| <span id="_CPPv37PrintToRK10ExpressionPNSt7ostreamE"></span><span id="_CPPv27PrintToRK10ExpressionPNSt7ostreamE"></span><span id="PrintTo__ExpressionCR.osP"></span><span class="target" id="group__expression-core_1ga51bf49f82df16f476a74b37b6ca13476"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PrintTo</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">Expression</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">ostream</span></span><span class="p"><span class="pre">*</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv47PrintToRK10ExpressionPNSt7ostreamE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv47literal5Datum"> |
| <span id="_CPPv37literal5Datum"></span><span id="_CPPv27literal5Datum"></span><span id="literal__Datum"></span><span class="target" id="group__expression-core_1ga4d71bf36ed71058ee8406cc68487f95d"></span><span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">literal</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">Datum</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">lit</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv47literal5Datum" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4I0E7literal10ExpressionRR3Arg"> |
| <span id="_CPPv3I0E7literalRR3Arg"></span><span id="_CPPv2I0E7literalRR3Arg"></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">Arg</span></span></span><span class="p"><span class="pre">></span></span><br /><span class="target" id="group__expression-core_1ga041bfb683da516972c62b0c8568677e0"></span><span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">literal</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4I0E7literal10ExpressionRR3Arg" title="literal::Arg"><span class="n"><span class="pre">Arg</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">arg</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4I0E7literal10ExpressionRR3Arg" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv49field_ref8FieldRef"> |
| <span id="_CPPv39field_ref8FieldRef"></span><span id="_CPPv29field_ref8FieldRef"></span><span id="field_ref__FieldRef"></span><span class="target" id="group__expression-core_1ga08c31c7d56188084cee5248b06756a61"></span><span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">field_ref</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">FieldRef</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">ref</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv49field_ref8FieldRef" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv44callNSt6stringENSt6vectorI10ExpressionEENSt10shared_ptrI15FunctionOptionsEE"> |
| <span id="_CPPv34callNSt6stringENSt6vectorI10ExpressionEENSt10shared_ptrI15FunctionOptionsEE"></span><span id="_CPPv24callNSt6stringENSt6vectorI10ExpressionEENSt10shared_ptrI15FunctionOptionsEE"></span><span id="call__ss.std::vector:Expression:.std::shared_ptr:FunctionOptions:"></span><span class="target" id="group__expression-core_1gaf0bad5f7319d4e010ba1ab8eb025e6d0"></span><span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">call</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">function</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">Expression</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">arguments</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">FunctionOptions</span></span><span class="p"><span class="pre">></span></span><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><span class="n"><span class="pre">NULLPTR</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv44callNSt6stringENSt6vectorI10ExpressionEENSt10shared_ptrI15FunctionOptionsEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4I00E4call10ExpressionNSt6stringENSt6vectorI10ExpressionEE7Options"> |
| <span id="_CPPv3I00E4callNSt6stringENSt6vectorI10ExpressionEE7Options"></span><span id="_CPPv2I00E4callNSt6stringENSt6vectorI10ExpressionEE7Options"></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">Options</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="w"> </span><span class="k"><span class="pre">typename</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_if</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">is_base_of</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">FunctionOptions</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4I00E4call10ExpressionNSt6stringENSt6vectorI10ExpressionEE7Options" title="call::Options"><span class="n"><span class="pre">Options</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">type</span></span><span class="p"><span class="pre">></span></span><br /><span class="target" id="group__expression-core_1ga3ea46788820a701a55925f3d67abb3c1"></span><span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">call</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">function</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">Expression</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">arguments</span></span>, <a class="reference internal" href="#_CPPv4I00E4call10ExpressionNSt6stringENSt6vectorI10ExpressionEE7Options" title="call::Options"><span class="n"><span class="pre">Options</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">options</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4I00E4call10ExpressionNSt6stringENSt6vectorI10ExpressionEE7Options" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv418FieldsInExpressionRK10Expression"> |
| <span id="_CPPv318FieldsInExpressionRK10Expression"></span><span id="_CPPv218FieldsInExpressionRK10Expression"></span><span id="FieldsInExpression__ExpressionCR"></span><span class="target" id="group__expression-core_1gade2d8c483b433f5bd5f8307843f3a202"></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">FieldRef</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">FieldsInExpression</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">Expression</span></span><span class="p"><span class="pre">&</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv418FieldsInExpressionRK10Expression" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Assemble a list of all fields referenced by an <a class="reference internal" href="#classarrow_1_1compute_1_1_expression"><span class="std std-ref">Expression</span></a> at any depth. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv422ExpressionHasFieldRefsRK10Expression"> |
| <span id="_CPPv322ExpressionHasFieldRefsRK10Expression"></span><span id="_CPPv222ExpressionHasFieldRefsRK10Expression"></span><span id="ExpressionHasFieldRefs__ExpressionCR"></span><span class="target" id="group__expression-core_1ga1be814a7a50b0790b1212a7898b696a9"></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">ExpressionHasFieldRefs</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">Expression</span></span><span class="p"><span class="pre">&</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv422ExpressionHasFieldRefsRK10Expression" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Check if the expression references any fields. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv423ExtractKnownFieldValuesRK10Expression"> |
| <span id="_CPPv323ExtractKnownFieldValuesRK10Expression"></span><span id="_CPPv223ExtractKnownFieldValuesRK10Expression"></span><span id="ExtractKnownFieldValues__ExpressionCR"></span><span class="target" id="group__expression-core_1ga9afa3b638b9fadc0876ac10bf80d4171"></span><span class="n"><span class="pre">Result</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">KnownFieldValues</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">ExtractKnownFieldValues</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">Expression</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">guaranteed_true_predicate</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv423ExtractKnownFieldValuesRK10Expression" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Assemble a mapping from field references to known values. </p> |
| <p>This derives known values from “equal” and “is_null” Expressions referencing a field and a literal. </p> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute10ExpressionE"> |
| <span id="_CPPv3N5arrow7compute10ExpressionE"></span><span id="_CPPv2N5arrow7compute10ExpressionE"></span><span id="arrow::compute::Expression"></span><span class="target" id="classarrow_1_1compute_1_1_expression"></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">Expression</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute10ExpressionE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/expression.h></em></div> |
| <p>An unbound expression which maps a single <a class="reference internal" href="#structarrow_1_1_datum"><span class="std std-ref">Datum</span></a> to another <a class="reference internal" href="#structarrow_1_1_datum"><span class="std std-ref">Datum</span></a>. </p> |
| <p>An expression is one of<ul class="simple"> |
| <li><p>A literal <a class="reference internal" href="#structarrow_1_1_datum"><span class="std std-ref">Datum</span></a>.</p></li> |
| <li><p>A reference to a single (potentially nested) field of the input <a class="reference internal" href="#structarrow_1_1_datum"><span class="std std-ref">Datum</span></a>.</p></li> |
| <li><p>A call to a compute function, with arguments specified by other Expressions. </p></li> |
| </ul> |
| </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="_CPPv4NK5arrow7compute10Expression4BindERK10TypeHolderP11ExecContext"> |
| <span id="_CPPv3NK5arrow7compute10Expression4BindERK10TypeHolderP11ExecContext"></span><span id="_CPPv2NK5arrow7compute10Expression4BindERK10TypeHolderP11ExecContext"></span><span id="arrow::compute::Expression::Bind__TypeHolderCR.ExecContextPC"></span><span class="target" id="classarrow_1_1compute_1_1_expression_1aa5c18e17248e7c79a5f416f17d54de88"></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="#_CPPv4N5arrow7compute10ExpressionE" title="arrow::compute::Expression"><span class="n"><span class="pre">Expression</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">Bind</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">TypeHolder</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">in</span></span>, <span class="n"><span class="pre">ExecContext</span></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="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="#_CPPv4NK5arrow7compute10Expression4BindERK10TypeHolderP11ExecContext" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Bind this expression to the given input type, looking up Kernels and field types. </p> |
| <p>Some expression simplification may be performed and implicit casts will be inserted. Any state necessary for execution will be initialized and returned. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow7compute10Expression7IsBoundEv"> |
| <span id="_CPPv3NK5arrow7compute10Expression7IsBoundEv"></span><span id="_CPPv2NK5arrow7compute10Expression7IsBoundEv"></span><span id="arrow::compute::Expression::IsBoundC"></span><span class="target" id="classarrow_1_1compute_1_1_expression_1a35df6ba11a3361ed9a9dc378efa2a7cb"></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">IsBound</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="#_CPPv4NK5arrow7compute10Expression7IsBoundEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return true if all an expression’s field references have explicit types and all of its functions’ kernels are looked up. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow7compute10Expression18IsScalarExpressionEv"> |
| <span id="_CPPv3NK5arrow7compute10Expression18IsScalarExpressionEv"></span><span id="_CPPv2NK5arrow7compute10Expression18IsScalarExpressionEv"></span><span id="arrow::compute::Expression::IsScalarExpressionC"></span><span class="target" id="classarrow_1_1compute_1_1_expression_1aa45205a97c477e30fdaf266e874a82a2"></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">IsScalarExpression</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="#_CPPv4NK5arrow7compute10Expression18IsScalarExpressionEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return true if this expression is composed only of <a class="reference internal" href="scalar.html#structarrow_1_1_scalar"><span class="std std-ref">Scalar</span></a> literals, field references, and calls to ScalarFunctions. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow7compute10Expression13IsNullLiteralEv"> |
| <span id="_CPPv3NK5arrow7compute10Expression13IsNullLiteralEv"></span><span id="_CPPv2NK5arrow7compute10Expression13IsNullLiteralEv"></span><span id="arrow::compute::Expression::IsNullLiteralC"></span><span class="target" id="classarrow_1_1compute_1_1_expression_1a90fe4ff926a148fd1655757e9fc0aff6"></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">IsNullLiteral</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="#_CPPv4NK5arrow7compute10Expression13IsNullLiteralEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return true if this expression is literal and entirely null. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow7compute10Expression13IsSatisfiableEv"> |
| <span id="_CPPv3NK5arrow7compute10Expression13IsSatisfiableEv"></span><span id="_CPPv2NK5arrow7compute10Expression13IsSatisfiableEv"></span><span id="arrow::compute::Expression::IsSatisfiableC"></span><span class="target" id="classarrow_1_1compute_1_1_expression_1a2c1a0c54ce943609149657ff3a61302a"></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">IsSatisfiable</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="#_CPPv4NK5arrow7compute10Expression13IsSatisfiableEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return true if this expression could evaluate to true. </p> |
| <p>Will return true for any unbound or non-boolean Expressions. IsSatisfiable does not (currently) do any canonicalization or simplification of the expression, so even Expressions which are unsatisfiable may spuriously return <code class="docutils literal notranslate"><span class="pre">true</span></code> here. This function is intended for use in predicate pushdown where a filter expression is simplified by a guarantee, so it assumes that trying to simplify again would be redundant. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow7compute10Expression4callEv"> |
| <span id="_CPPv3NK5arrow7compute10Expression4callEv"></span><span id="_CPPv2NK5arrow7compute10Expression4callEv"></span><span id="arrow::compute::Expression::callC"></span><span class="target" id="classarrow_1_1compute_1_1_expression_1a1e8baf4eec75e5c4c32cafb0de09ee78"></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow7compute10Expression4CallE" title="arrow::compute::Expression::Call"><span class="n"><span class="pre">Call</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">call</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="#_CPPv4NK5arrow7compute10Expression4callEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Access a <a class="reference internal" href="#structarrow_1_1compute_1_1_expression_1_1_call"><span class="std std-ref">Call</span></a> or return nullptr if this expression is not a call. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow7compute10Expression7literalEv"> |
| <span id="_CPPv3NK5arrow7compute10Expression7literalEv"></span><span id="_CPPv2NK5arrow7compute10Expression7literalEv"></span><span id="arrow::compute::Expression::literalC"></span><span class="target" id="classarrow_1_1compute_1_1_expression_1af2e5b5117cc4c8642eac65556af91c96"></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow5DatumE" title="arrow::Datum"><span class="n"><span class="pre">Datum</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">literal</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="#_CPPv4NK5arrow7compute10Expression7literalEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Access a <a class="reference internal" href="#structarrow_1_1_datum"><span class="std std-ref">Datum</span></a> or return nullptr if this expression is not a literal. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow7compute10Expression9field_refEv"> |
| <span id="_CPPv3NK5arrow7compute10Expression9field_refEv"></span><span id="_CPPv2NK5arrow7compute10Expression9field_refEv"></span><span id="arrow::compute::Expression::field_refC"></span><span class="target" id="classarrow_1_1compute_1_1_expression_1a56f61184d5fb7267f15e216194820f31"></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="datatype.html#_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="sig-name descname"><span class="n"><span class="pre">field_ref</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="#_CPPv4NK5arrow7compute10Expression9field_refEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Access a <a class="reference internal" href="datatype.html#classarrow_1_1_field_ref"><span class="std std-ref">FieldRef</span></a> or return nullptr if this expression is not a field_ref. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow7compute10Expression4typeEv"> |
| <span id="_CPPv3NK5arrow7compute10Expression4typeEv"></span><span id="_CPPv2NK5arrow7compute10Expression4typeEv"></span><span id="arrow::compute::Expression::typeC"></span><span class="target" id="classarrow_1_1compute_1_1_expression_1a19763ec7bf13b2eadc2f96bccbdcc97d"></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="datatype.html#_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="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="#_CPPv4NK5arrow7compute10Expression4typeEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The type to which this expression will evaluate. </p> |
| </dd></dl> |
| |
| </div> |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute10Expression4CallE"> |
| <span id="_CPPv3N5arrow7compute10Expression4CallE"></span><span id="_CPPv2N5arrow7compute10Expression4CallE"></span><span id="arrow::compute::Expression::Call"></span><span class="target" id="structarrow_1_1compute_1_1_expression_1_1_call"></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">Call</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute10Expression4CallE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/expression.h></em></div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute10Expression4HashE"> |
| <span id="_CPPv3N5arrow7compute10Expression4HashE"></span><span id="_CPPv2N5arrow7compute10Expression4HashE"></span><span id="arrow::compute::Expression::Hash"></span><span class="target" id="structarrow_1_1compute_1_1_expression_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="#_CPPv4N5arrow7compute10Expression4HashE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/expression.h></em></div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7compute10Expression9ParameterE"> |
| <span id="_CPPv3N5arrow7compute10Expression9ParameterE"></span><span id="_CPPv2N5arrow7compute10Expression9ParameterE"></span><span id="arrow::compute::Expression::Parameter"></span><span class="target" id="structarrow_1_1compute_1_1_expression_1_1_parameter"></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">Parameter</span></span></span><a class="headerlink" href="#_CPPv4N5arrow7compute10Expression9ParameterE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/compute/expression.h></em></div> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv47projectNSt6vectorI10ExpressionEENSt6vectorINSt6stringEEE"> |
| <span id="_CPPv37projectNSt6vectorI10ExpressionEENSt6vectorINSt6stringEEE"></span><span id="_CPPv27projectNSt6vectorI10ExpressionEENSt6vectorINSt6stringEEE"></span><span id="project__std::vector:Expression:.std::vector:ss:"></span><span class="target" id="group__expression-convenience_1ga63e06c3c10e9660d262493a2d02208ff"></span><span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">project</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="n"><span class="pre">Expression</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">values</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">names</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv47projectNSt6vectorI10ExpressionEENSt6vectorINSt6stringEEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv45equal10Expression10Expression"> |
| <span id="_CPPv35equal10Expression10Expression"></span><span id="_CPPv25equal10Expression10Expression"></span><span id="equal__Expression.Expression"></span><span class="target" id="group__expression-convenience_1ga7fbe9b99666f9bbdbb4e01f8224e9ac1"></span><span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">equal</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">lhs</span></span>, <span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">rhs</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv45equal10Expression10Expression" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv49not_equal10Expression10Expression"> |
| <span id="_CPPv39not_equal10Expression10Expression"></span><span id="_CPPv29not_equal10Expression10Expression"></span><span id="not_equal__Expression.Expression"></span><span class="target" id="group__expression-convenience_1gadbaaab39f64a199bfad60c33b5dca5c0"></span><span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">not_equal</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">lhs</span></span>, <span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">rhs</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv49not_equal10Expression10Expression" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv44less10Expression10Expression"> |
| <span id="_CPPv34less10Expression10Expression"></span><span id="_CPPv24less10Expression10Expression"></span><span id="less__Expression.Expression"></span><span class="target" id="group__expression-convenience_1ga9b34c0783227ebd979d732f501856496"></span><span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">less</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">lhs</span></span>, <span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">rhs</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv44less10Expression10Expression" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv410less_equal10Expression10Expression"> |
| <span id="_CPPv310less_equal10Expression10Expression"></span><span id="_CPPv210less_equal10Expression10Expression"></span><span id="less_equal__Expression.Expression"></span><span class="target" id="group__expression-convenience_1gadee893687729394a6760315e2f212905"></span><span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">less_equal</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">lhs</span></span>, <span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">rhs</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv410less_equal10Expression10Expression" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv47greater10Expression10Expression"> |
| <span id="_CPPv37greater10Expression10Expression"></span><span id="_CPPv27greater10Expression10Expression"></span><span id="greater__Expression.Expression"></span><span class="target" id="group__expression-convenience_1ga151949dbf2c0a55b9a543f01d50f2920"></span><span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">greater</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">lhs</span></span>, <span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">rhs</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv47greater10Expression10Expression" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv413greater_equal10Expression10Expression"> |
| <span id="_CPPv313greater_equal10Expression10Expression"></span><span id="_CPPv213greater_equal10Expression10Expression"></span><span id="greater_equal__Expression.Expression"></span><span class="target" id="group__expression-convenience_1ga2c94910f996cdafadd4999ba9b0749fb"></span><span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">greater_equal</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">lhs</span></span>, <span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">rhs</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv413greater_equal10Expression10Expression" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv47is_null10Expressionb"> |
| <span id="_CPPv37is_null10Expressionb"></span><span id="_CPPv27is_null10Expressionb"></span><span id="is_null__Expression.b"></span><span class="target" id="group__expression-convenience_1ga3a7f150e04bd72b7a7a957a148bfcc0b"></span><span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">is_null</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">lhs</span></span>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">nan_is_null</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="#_CPPv47is_null10Expressionb" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv48is_valid10Expression"> |
| <span id="_CPPv38is_valid10Expression"></span><span id="_CPPv28is_valid10Expression"></span><span id="is_valid__Expression"></span><span class="target" id="group__expression-convenience_1ga4f4042192842c51c5fb44f57ea3c9787"></span><span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">is_valid</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">lhs</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv48is_valid10Expression" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv44and_10Expression10Expression"> |
| <span id="_CPPv34and_10Expression10Expression"></span><span id="_CPPv24and_10Expression10Expression"></span><span id="and___Expression.Expression"></span><span class="target" id="group__expression-convenience_1ga522783b0bd2720a80274a859567eb56d"></span><span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">and_</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">lhs</span></span>, <span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">rhs</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv44and_10Expression10Expression" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv44and_RKNSt6vectorI10ExpressionEE"> |
| <span id="_CPPv34and_RKNSt6vectorI10ExpressionEE"></span><span id="_CPPv24and_RKNSt6vectorI10ExpressionEE"></span><span id="and___std::vector:Expression:CR"></span><span class="target" id="group__expression-convenience_1gaf8ee8b99da0dd8fc2682cabcebd80c67"></span><span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">and_</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">Expression</span></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="#_CPPv44and_RKNSt6vectorI10ExpressionEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv43or_10Expression10Expression"> |
| <span id="_CPPv33or_10Expression10Expression"></span><span id="_CPPv23or_10Expression10Expression"></span><span id="or___Expression.Expression"></span><span class="target" id="group__expression-convenience_1ga2c846bf59fe8a2b37ed09c9199f6f114"></span><span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">or_</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">lhs</span></span>, <span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">rhs</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv43or_10Expression10Expression" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv43or_RKNSt6vectorI10ExpressionEE"> |
| <span id="_CPPv33or_RKNSt6vectorI10ExpressionEE"></span><span id="_CPPv23or_RKNSt6vectorI10ExpressionEE"></span><span id="or___std::vector:Expression:CR"></span><span class="target" id="group__expression-convenience_1ga87a0bf7051bcf031ba9cf75a3bcf5961"></span><span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">or_</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">Expression</span></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="#_CPPv43or_RKNSt6vectorI10ExpressionEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv44not_10Expression"> |
| <span id="_CPPv34not_10Expression"></span><span id="_CPPv24not_10Expression"></span><span id="not___Expression"></span><span class="target" id="group__expression-convenience_1ga4c9533f4a583d9d23b3248ef290df082"></span><span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">not_</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">operand</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv44not_10Expression" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv412Canonicalize10ExpressionP11ExecContext"> |
| <span id="_CPPv312Canonicalize10ExpressionP11ExecContext"></span><span id="_CPPv212Canonicalize10ExpressionP11ExecContext"></span><span id="Canonicalize__Expression.ExecContextP"></span><span class="target" id="group__expression-passes_1gab4592c7ddfba9484153e8e36d955cdc2"></span><span class="n"><span class="pre">Result</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">Expression</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">Canonicalize</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">Expression</span></span>, <span class="n"><span class="pre">ExecContext</span></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="n"><span class="pre">NULLPTR</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv412Canonicalize10ExpressionP11ExecContext" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Weak canonicalization which establishes guarantees for subsequent passes. </p> |
| <p>Even equivalent Expressions may result in different canonicalized expressions. TODO this could be a strong canonicalization </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv413FoldConstants10Expression"> |
| <span id="_CPPv313FoldConstants10Expression"></span><span id="_CPPv213FoldConstants10Expression"></span><span id="FoldConstants__Expression"></span><span class="target" id="group__expression-passes_1ga53cba9163da90f4a8b562b4995d5bf63"></span><span class="n"><span class="pre">Result</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">Expression</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">FoldConstants</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">Expression</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv413FoldConstants10Expression" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Simplify Expressions based on literal arguments (for example, add(null, x) will always be null so replace the call with a null literal). </p> |
| <p>Includes early evaluation of all calls whose arguments are entirely literal. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv428ReplaceFieldsWithKnownValuesRK16KnownFieldValues10Expression"> |
| <span id="_CPPv328ReplaceFieldsWithKnownValuesRK16KnownFieldValues10Expression"></span><span id="_CPPv228ReplaceFieldsWithKnownValuesRK16KnownFieldValues10Expression"></span><span id="ReplaceFieldsWithKnownValues__KnownFieldValuesCR.Expression"></span><span class="target" id="group__expression-passes_1ga2cd03bf604047bfa6ca5924a05eddf2b"></span><span class="n"><span class="pre">Result</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">Expression</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">ReplaceFieldsWithKnownValues</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">KnownFieldValues</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">known_values</span></span>, <span class="n"><span class="pre">Expression</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv428ReplaceFieldsWithKnownValuesRK16KnownFieldValues10Expression" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Simplify Expressions by replacing with known values of the fields which it references. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv421SimplifyWithGuarantee10ExpressionRK10Expression"> |
| <span id="_CPPv321SimplifyWithGuarantee10ExpressionRK10Expression"></span><span id="_CPPv221SimplifyWithGuarantee10ExpressionRK10Expression"></span><span id="SimplifyWithGuarantee__Expression.ExpressionCR"></span><span class="target" id="group__expression-passes_1ga18a718236c8b2ad0df2a8db75aa5c64c"></span><span class="n"><span class="pre">Result</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">Expression</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">SimplifyWithGuarantee</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">Expression</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">guaranteed_true_predicate</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv421SimplifyWithGuarantee10ExpressionRK10Expression" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Simplify an expression by replacing subexpressions based on a guarantee: a boolean expression which is guaranteed to evaluate to <code class="docutils literal notranslate"><span class="pre">true</span></code>. </p> |
| <p>For example, this is used to remove redundant function calls from a filter expression or to replace a reference to a constant-value field with a literal. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv415RemoveNamedRefs10Expression"> |
| <span id="_CPPv315RemoveNamedRefs10Expression"></span><span id="_CPPv215RemoveNamedRefs10Expression"></span><span id="RemoveNamedRefs__Expression"></span><span class="target" id="group__expression-passes_1ga7a38456ce85bc04f0667c0bb3b691f37"></span><span class="n"><span class="pre">Result</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">Expression</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">RemoveNamedRefs</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">Expression</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">expression</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv415RemoveNamedRefs10Expression" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Replace all named field refs (e.g. </p> |
| <p>“x” or “x.y”) with field paths (e.g. [0] or [1,3])</p> |
| <p>This isn’t usually needed and does not offer any simplification by itself. However, it can be useful to normalize an expression to paths to make it simpler to work with. </p> |
| </dd></dl> |
| |
| </section> |
| </section> |
| |
| |
| </article> |
| |
| |
| |
| |
| |
| <footer class="prev-next-footer"> |
| |
| <div class="prev-next-area"> |
| <a class="left-prev" |
| href="c_abi.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">C Interfaces</p> |
| </div> |
| </a> |
| <a class="right-next" |
| href="acero.html" |
| title="next page"> |
| <div class="prev-next-info"> |
| <p class="prev-next-subtitle">next</p> |
| <p class="prev-next-title">Streaming Execution (Acero)</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="#datum-class">Datum class</a></li> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#abstract-function-classes">Abstract Function classes</a></li> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#function-execution">Function execution</a></li> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#function-registry">Function registry</a></li> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#convenience-functions">Convenience functions</a></li> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#concrete-options-classes">Concrete options classes</a></li> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#compute-expressions">Compute Expressions</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/compute.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> |
