| |
| <!DOCTYPE html> |
| |
| <html> |
| <head> |
| <meta charset="utf-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <title>Compute Functions — Apache Arrow v4.0.1</title> |
| |
| <link href="../../_static/css/theme.css" rel="stylesheet" /> |
| <link href="../../_static/css/index.c5995385ac14fb8791e8eb36b4908be2.css" rel="stylesheet" /> |
| |
| |
| <link rel="stylesheet" |
| href="../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> |
| <link rel="preload" as="font" type="font/woff2" crossorigin |
| href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> |
| <link rel="preload" as="font" type="font/woff2" crossorigin |
| href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> |
| |
| |
| |
| |
| |
| <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" /> |
| <link rel="stylesheet" type="text/css" href="../../_static/basic.css" /> |
| <link rel="stylesheet" type="text/css" href="../../_static/theme_overrides.css" /> |
| |
| <link rel="preload" as="script" href="../../_static/js/index.1c5a1a01449ed65a7b51.js"> |
| |
| <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script> |
| <script src="../../_static/jquery.js"></script> |
| <script src="../../_static/underscore.js"></script> |
| <script src="../../_static/doctools.js"></script> |
| <link rel="canonical" href="https://arrow.apache.org/docs/python/api/compute.html" /> |
| <link rel="shortcut icon" href="../../_static/favicon.ico"/> |
| <link rel="canonical" href="https://arrow.apache.org/docs/python/api/compute.html" /> |
| <link rel="index" title="Index" href="../../genindex.html" /> |
| <link rel="search" title="Search" href="../../search.html" /> |
| <link rel="next" title="pyarrow.compute.count" href="../generated/pyarrow.compute.count.html" /> |
| <link rel="prev" title="pyarrow.total_allocated_bytes" href="../generated/pyarrow.total_allocated_bytes.html" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1" /> |
| <meta name="docsearch:language" content="en" /> |
| |
| </head> |
| <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="80"> |
| |
| <div class="container-fluid" id="banner"></div> |
| |
| |
| |
| |
| <div class="container-xl"> |
| <div class="row"> |
| |
| |
| <!-- Only show if we have sidebars configured, else just a small margin --> |
| <div class="col-12 col-md-3 bd-sidebar"> |
| <a class="navbar-brand" href="../../index.html"> |
| <img src="../../_static/arrow.png" class="logo" alt="logo"> |
| </a> |
| |
| <form class="bd-search d-flex align-items-center" action="../../search.html" method="get"> |
| <i class="icon fas fa-search"></i> |
| <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" > |
| </form> |
| |
| <nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation"> |
| <div class="bd-toc-item active"> |
| |
| <p class="caption"> |
| <span class="caption-text"> |
| Specifications and Protocols |
| </span> |
| </p> |
| <ul class="nav bd-sidenav"> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="../../format/Versioning.html"> |
| Format Versioning and Stability |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="../../format/Columnar.html"> |
| Arrow Columnar Format |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="../../format/Flight.html"> |
| Arrow Flight RPC |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="../../format/Integration.html"> |
| Integration Testing |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="../../format/CDataInterface.html"> |
| The Arrow C data interface |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="../../format/CStreamInterface.html"> |
| The Arrow C stream interface |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="../../format/Other.html"> |
| Other Data Structures |
| </a> |
| </li> |
| </ul> |
| <p class="caption"> |
| <span class="caption-text"> |
| Libraries |
| </span> |
| </p> |
| <ul class="current nav bd-sidenav"> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="../../status.html"> |
| Implementation Status |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference external" href="https://arrow.apache.org/docs/c_glib/"> |
| C/GLib |
| </a> |
| </li> |
| <li class="toctree-l1 has-children"> |
| <a class="reference internal" href="../../cpp/index.html"> |
| C++ |
| </a> |
| <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/> |
| <label for="toctree-checkbox-1"> |
| <i class="fas fa-chevron-down"> |
| </i> |
| </label> |
| <ul> |
| <li class="toctree-l2 has-children"> |
| <a class="reference internal" href="../../cpp/getting_started.html"> |
| User Guide |
| </a> |
| <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/> |
| <label for="toctree-checkbox-2"> |
| <i class="fas fa-chevron-down"> |
| </i> |
| </label> |
| <ul> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../cpp/overview.html"> |
| High-Level Overview |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../cpp/conventions.html"> |
| Conventions |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../cpp/cmake.html"> |
| Using Arrow C++ in your own project |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../cpp/memory.html"> |
| Memory Management |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../cpp/arrays.html"> |
| Arrays |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../cpp/datatypes.html"> |
| Data Types |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../cpp/tables.html"> |
| Tabular Data |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../cpp/compute.html"> |
| Compute Functions |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../cpp/io.html"> |
| Input / output and filesystems |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../cpp/ipc.html"> |
| Reading and writing the Arrow IPC format |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../cpp/parquet.html"> |
| Reading and writing Parquet files |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../cpp/csv.html"> |
| Reading CSV files |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../cpp/json.html"> |
| Reading JSON files |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../cpp/dataset.html"> |
| Tabular Datasets |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../cpp/flight.html"> |
| Arrow Flight RPC |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l2 has-children"> |
| <a class="reference internal" href="../../cpp/examples/index.html"> |
| Examples |
| </a> |
| <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/> |
| <label for="toctree-checkbox-3"> |
| <i class="fas fa-chevron-down"> |
| </i> |
| </label> |
| <ul> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../cpp/examples/cmake_minimal_build.html"> |
| Minimal build using CMake |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../cpp/examples/dataset_documentation_example.html"> |
| Arrow Datasets example |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../cpp/examples/row_columnar_conversion.html"> |
| Row to columnar conversion |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../cpp/examples/tuple_range_conversion.html"> |
| std::tuple-like ranges to Arrow |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l2 has-children"> |
| <a class="reference internal" href="../../cpp/api.html"> |
| API Reference |
| </a> |
| <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/> |
| <label for="toctree-checkbox-4"> |
| <i class="fas fa-chevron-down"> |
| </i> |
| </label> |
| <ul> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../cpp/api/support.html"> |
| Programming Support |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../cpp/api/memory.html"> |
| Memory (management) |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../cpp/api/datatype.html"> |
| Data Types |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../cpp/api/array.html"> |
| Arrays |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../cpp/api/scalar.html"> |
| Scalars |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../cpp/api/builder.html"> |
| Array Builders |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../cpp/api/table.html"> |
| Two-dimensional Datasets |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../cpp/api/c_abi.html"> |
| C Interfaces |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../cpp/api/compute.html"> |
| Compute Functions |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../cpp/api/tensor.html"> |
| Tensors |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../cpp/api/utilities.html"> |
| Utilities |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../cpp/api/io.html"> |
| Input / output |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../cpp/api/ipc.html"> |
| Arrow IPC |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../cpp/api/formats.html"> |
| File Formats |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../cpp/api/cuda.html"> |
| CUDA support |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../cpp/api/flight.html"> |
| Arrow Flight RPC |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../cpp/api/filesystem.html"> |
| Filesystems |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../cpp/api/dataset.html"> |
| Dataset |
| </a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference external" href="https://github.com/apache/arrow/blob/master/csharp/README.md"> |
| C# |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference external" href="https://godoc.org/github.com/apache/arrow/go/arrow"> |
| Go |
| </a> |
| </li> |
| <li class="toctree-l1 has-children"> |
| <a class="reference internal" href="../../java/index.html"> |
| Java |
| </a> |
| <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/> |
| <label for="toctree-checkbox-5"> |
| <i class="fas fa-chevron-down"> |
| </i> |
| </label> |
| <ul> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../java/vector.html"> |
| ValueVector |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../java/vector_schema_root.html"> |
| VectorSchemaRoot |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../java/ipc.html"> |
| Reading/Writing IPC formats |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference external" href="https://arrow.apache.org/docs/java/reference/"> |
| Reference (javadoc) |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference external" href="https://arrow.apache.org/docs/js/"> |
| JavaScript |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference external" href="https://github.com/apache/arrow/blob/master/julia/Arrow/README.md"> |
| Julia |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference external" href="https://github.com/apache/arrow/blob/master/matlab/README.md"> |
| MATLAB |
| </a> |
| </li> |
| <li class="toctree-l1 current active has-children"> |
| <a class="reference internal" href="../index.html"> |
| Python |
| </a> |
| <input checked="" class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"/> |
| <label for="toctree-checkbox-6"> |
| <i class="fas fa-chevron-down"> |
| </i> |
| </label> |
| <ul class="current"> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../install.html"> |
| Installing PyArrow |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../memory.html"> |
| Memory and IO Interfaces |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../data.html"> |
| Data Types and In-Memory Data Model |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../compute.html"> |
| Compute Functions |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../ipc.html"> |
| Streaming, Serialization, and IPC |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../filesystems.html"> |
| Filesystem Interface |
| </a> |
| </li> |
| <li class="toctree-l2 has-children"> |
| <a class="reference internal" href="../filesystems_deprecated.html"> |
| Filesystem Interface (legacy) |
| </a> |
| <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"/> |
| <label for="toctree-checkbox-7"> |
| <i class="fas fa-chevron-down"> |
| </i> |
| </label> |
| <ul> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../generated/pyarrow.hdfs.connect.html"> |
| pyarrow.hdfs.connect |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../generated/pyarrow.HadoopFileSystem.cat.html"> |
| pyarrow.HadoopFileSystem.cat |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../generated/pyarrow.HadoopFileSystem.chmod.html"> |
| pyarrow.HadoopFileSystem.chmod |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../generated/pyarrow.HadoopFileSystem.chown.html"> |
| pyarrow.HadoopFileSystem.chown |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../generated/pyarrow.HadoopFileSystem.delete.html"> |
| pyarrow.HadoopFileSystem.delete |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../generated/pyarrow.HadoopFileSystem.df.html"> |
| pyarrow.HadoopFileSystem.df |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../generated/pyarrow.HadoopFileSystem.disk_usage.html"> |
| pyarrow.HadoopFileSystem.disk_usage |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../generated/pyarrow.HadoopFileSystem.download.html"> |
| pyarrow.HadoopFileSystem.download |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../generated/pyarrow.HadoopFileSystem.exists.html"> |
| pyarrow.HadoopFileSystem.exists |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../generated/pyarrow.HadoopFileSystem.get_capacity.html"> |
| pyarrow.HadoopFileSystem.get_capacity |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../generated/pyarrow.HadoopFileSystem.get_space_used.html"> |
| pyarrow.HadoopFileSystem.get_space_used |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../generated/pyarrow.HadoopFileSystem.info.html"> |
| pyarrow.HadoopFileSystem.info |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../generated/pyarrow.HadoopFileSystem.ls.html"> |
| pyarrow.HadoopFileSystem.ls |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../generated/pyarrow.HadoopFileSystem.mkdir.html"> |
| pyarrow.HadoopFileSystem.mkdir |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../generated/pyarrow.HadoopFileSystem.open.html"> |
| pyarrow.HadoopFileSystem.open |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../generated/pyarrow.HadoopFileSystem.rename.html"> |
| pyarrow.HadoopFileSystem.rename |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../generated/pyarrow.HadoopFileSystem.rm.html"> |
| pyarrow.HadoopFileSystem.rm |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../generated/pyarrow.HadoopFileSystem.upload.html"> |
| pyarrow.HadoopFileSystem.upload |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../generated/pyarrow.HdfsFile.html"> |
| pyarrow.HdfsFile |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../plasma.html"> |
| The Plasma In-Memory Object Store |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../numpy.html"> |
| NumPy Integration |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../pandas.html"> |
| Pandas Integration |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../timestamps.html"> |
| Timestamps |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../csv.html"> |
| Reading CSV files |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../feather.html"> |
| Feather File Format |
| </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="../parquet.html"> |
| Reading and Writing the Apache Parquet Format |
| </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="../cuda.html"> |
| CUDA Integration |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../extending_types.html"> |
| Extending pyarrow |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../extending.html"> |
| Using pyarrow from C++ and Cython Code |
| </a> |
| </li> |
| <li class="toctree-l2 current active has-children"> |
| <a class="reference internal" href="../api.html"> |
| API Reference |
| </a> |
| <input checked="" class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"/> |
| <label for="toctree-checkbox-8"> |
| <i class="fas fa-chevron-down"> |
| </i> |
| </label> |
| <ul class="current"> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="datatypes.html"> |
| Data Types and Schemas |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="arrays.html"> |
| Arrays and Scalars |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="memory.html"> |
| Buffers and Memory |
| </a> |
| </li> |
| <li class="toctree-l3 current active"> |
| <a class="current reference internal" href="#"> |
| Compute Functions |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="files.html"> |
| Streams and File Access |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="tables.html"> |
| Tables and Tensors |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="ipc.html"> |
| Serialization and IPC |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="flight.html"> |
| Arrow Flight |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="formats.html"> |
| Tabular File Formats |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="filesystems.html"> |
| Filesystems |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="dataset.html"> |
| Dataset |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="plasma.html"> |
| Plasma In-Memory Object Store |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="cuda.html"> |
| CUDA Integration |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="misc.html"> |
| Miscellaneous |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../getting_involved.html"> |
| Getting Involved |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../benchmarks.html"> |
| Benchmarks |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference external" href="https://arrow.apache.org/docs/r/"> |
| R |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference external" href="https://github.com/apache/arrow/blob/master/ruby/README.md"> |
| Ruby |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference external" href="https://docs.rs/crate/arrow/"> |
| Rust |
| </a> |
| </li> |
| </ul> |
| <p class="caption"> |
| <span class="caption-text"> |
| Development |
| </span> |
| </p> |
| <ul class="nav bd-sidenav"> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="../../developers/contributing.html"> |
| Contributing to Apache Arrow |
| </a> |
| </li> |
| <li class="toctree-l1 has-children"> |
| <a class="reference internal" href="../../developers/cpp/index.html"> |
| C++ Development |
| </a> |
| <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"/> |
| <label for="toctree-checkbox-9"> |
| <i class="fas fa-chevron-down"> |
| </i> |
| </label> |
| <ul> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../developers/cpp/building.html"> |
| Building Arrow C++ |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../developers/cpp/development.html"> |
| Development Guidelines |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../developers/cpp/windows.html"> |
| Developing on Windows |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../developers/cpp/conventions.html"> |
| Conventions |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../developers/cpp/fuzzing.html"> |
| Fuzzing Arrow C++ |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="../../developers/python.html"> |
| Python Development |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="../../developers/archery.html"> |
| Daily Development using Archery |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="../../developers/crossbow.html"> |
| Packaging and Testing with Crossbow |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="../../developers/docker.html"> |
| Running Docker Builds |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="../../developers/benchmarks.html"> |
| Benchmarks |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="../../developers/documentation.html"> |
| Building the Documentation |
| </a> |
| </li> |
| </ul> |
| |
| |
| </div> |
| </nav> |
| </div> |
| |
| |
| |
| |
| <div class="d-none d-xl-block col-xl-2 bd-toc"> |
| |
| |
| <div class="toc-item"> |
| |
| <div class="tocsection onthispage pt-5 pb-3"> |
| <i class="fas fa-list"></i> On this page |
| </div> |
| |
| <nav id="bd-toc-nav"> |
| <ul class="visible nav section-nav flex-column"> |
| <li class="toc-h2 nav-item toc-entry"> |
| <a class="reference internal nav-link" href="#aggregations"> |
| Aggregations |
| </a> |
| </li> |
| <li class="toc-h2 nav-item toc-entry"> |
| <a class="reference internal nav-link" href="#arithmetic-functions"> |
| Arithmetic Functions |
| </a> |
| </li> |
| <li class="toc-h2 nav-item toc-entry"> |
| <a class="reference internal nav-link" href="#comparisons"> |
| Comparisons |
| </a> |
| </li> |
| <li class="toc-h2 nav-item toc-entry"> |
| <a class="reference internal nav-link" href="#logical-functions"> |
| Logical Functions |
| </a> |
| </li> |
| <li class="toc-h2 nav-item toc-entry"> |
| <a class="reference internal nav-link" href="#string-predicates"> |
| String Predicates |
| </a> |
| <ul class="visible nav section-nav flex-column"> |
| </ul> |
| </li> |
| <li class="toc-h2 nav-item toc-entry"> |
| <a class="reference internal nav-link" href="#string-transforms"> |
| String Transforms |
| </a> |
| </li> |
| <li class="toc-h2 nav-item toc-entry"> |
| <a class="reference internal nav-link" href="#containment-tests"> |
| Containment tests |
| </a> |
| </li> |
| <li class="toc-h2 nav-item toc-entry"> |
| <a class="reference internal nav-link" href="#conversions"> |
| Conversions |
| </a> |
| </li> |
| <li class="toc-h2 nav-item toc-entry"> |
| <a class="reference internal nav-link" href="#selections"> |
| Selections |
| </a> |
| </li> |
| <li class="toc-h2 nav-item toc-entry"> |
| <a class="reference internal nav-link" href="#associative-transforms"> |
| Associative transforms |
| </a> |
| </li> |
| <li class="toc-h2 nav-item toc-entry"> |
| <a class="reference internal nav-link" href="#sorts-and-partitions"> |
| Sorts and partitions |
| </a> |
| </li> |
| <li class="toc-h2 nav-item toc-entry"> |
| <a class="reference internal nav-link" href="#structural-transforms"> |
| Structural Transforms |
| </a> |
| </li> |
| </ul> |
| |
| </nav> |
| </div> |
| |
| <div class="toc-item"> |
| |
| </div> |
| |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| <main class="col-12 col-md-9 col-xl-7 py-md-5 pl-md-5 pr-md-4 bd-content" role="main"> |
| |
| <div> |
| |
| <div class="section" id="compute-functions"> |
| <span id="api-compute"></span><h1>Compute Functions<a class="headerlink" href="#compute-functions" title="Permalink to this headline">¶</a></h1> |
| <div class="section" id="aggregations"> |
| <h2>Aggregations<a class="headerlink" href="#aggregations" title="Permalink to this headline">¶</a></h2> |
| <table class="longtable table autosummary"> |
| <colgroup> |
| <col style="width: 10%" /> |
| <col style="width: 90%" /> |
| </colgroup> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.compute.count.html#pyarrow.compute.count" title="pyarrow.compute.count"><code class="xref py py-obj docutils literal notranslate"><span class="pre">count</span></code></a>(array, *[, options, memory_pool])</p></td> |
| <td><p>Count the number of null / non-null values.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.compute.mean.html#pyarrow.compute.mean" title="pyarrow.compute.mean"><code class="xref py py-obj docutils literal notranslate"><span class="pre">mean</span></code></a>(array, *[, memory_pool])</p></td> |
| <td><p>Compute the mean of a numeric array.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.compute.min_max.html#pyarrow.compute.min_max" title="pyarrow.compute.min_max"><code class="xref py py-obj docutils literal notranslate"><span class="pre">min_max</span></code></a>(array, *[, options, memory_pool])</p></td> |
| <td><p>Compute the minimum and maximum values of a numeric array.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.compute.mode.html#pyarrow.compute.mode" title="pyarrow.compute.mode"><code class="xref py py-obj docutils literal notranslate"><span class="pre">mode</span></code></a>(array[, n])</p></td> |
| <td><p>Return top-n most common values and number of times they occur in a passed numerical (chunked) array, in descending order of occurance.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.compute.stddev.html#pyarrow.compute.stddev" title="pyarrow.compute.stddev"><code class="xref py py-obj docutils literal notranslate"><span class="pre">stddev</span></code></a>(array, *[, options, memory_pool])</p></td> |
| <td><p>Calculate the standard deviation of a numeric array.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.compute.sum.html#pyarrow.compute.sum" title="pyarrow.compute.sum"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sum</span></code></a>(array)</p></td> |
| <td><p>Sum the values in a numerical (chunked) array.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.compute.variance.html#pyarrow.compute.variance" title="pyarrow.compute.variance"><code class="xref py py-obj docutils literal notranslate"><span class="pre">variance</span></code></a>(array, *[, options, memory_pool])</p></td> |
| <td><p>Calculate the variance of a numeric array.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="section" id="arithmetic-functions"> |
| <h2>Arithmetic Functions<a class="headerlink" href="#arithmetic-functions" title="Permalink to this headline">¶</a></h2> |
| <p>By default these functions do not detect overflow. Each function is also |
| available in an overflow-checking variant, suffixed <code class="docutils literal notranslate"><span class="pre">_checked</span></code>, which |
| throws an <code class="docutils literal notranslate"><span class="pre">ArrowInvalid</span></code> exception when overflow is detected.</p> |
| <table class="longtable table autosummary"> |
| <colgroup> |
| <col style="width: 10%" /> |
| <col style="width: 90%" /> |
| </colgroup> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.compute.add.html#pyarrow.compute.add" title="pyarrow.compute.add"><code class="xref py py-obj docutils literal notranslate"><span class="pre">add</span></code></a>(x, y, *[, memory_pool])</p></td> |
| <td><p>Add the arguments element-wise.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.compute.add_checked.html#pyarrow.compute.add_checked" title="pyarrow.compute.add_checked"><code class="xref py py-obj docutils literal notranslate"><span class="pre">add_checked</span></code></a>(x, y, *[, memory_pool])</p></td> |
| <td><p>Add the arguments element-wise.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.compute.divide.html#pyarrow.compute.divide" title="pyarrow.compute.divide"><code class="xref py py-obj docutils literal notranslate"><span class="pre">divide</span></code></a>(dividend, divisor, *[, memory_pool])</p></td> |
| <td><p>Divide the arguments element-wise.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.compute.divide_checked.html#pyarrow.compute.divide_checked" title="pyarrow.compute.divide_checked"><code class="xref py py-obj docutils literal notranslate"><span class="pre">divide_checked</span></code></a>(dividend, divisor, *[, …])</p></td> |
| <td><p>Divide the arguments element-wise.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.compute.multiply.html#pyarrow.compute.multiply" title="pyarrow.compute.multiply"><code class="xref py py-obj docutils literal notranslate"><span class="pre">multiply</span></code></a>(x, y, *[, memory_pool])</p></td> |
| <td><p>Multiply the arguments element-wise.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.compute.multiply_checked.html#pyarrow.compute.multiply_checked" title="pyarrow.compute.multiply_checked"><code class="xref py py-obj docutils literal notranslate"><span class="pre">multiply_checked</span></code></a>(x, y, *[, memory_pool])</p></td> |
| <td><p>Multiply the arguments element-wise.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.compute.subtract.html#pyarrow.compute.subtract" title="pyarrow.compute.subtract"><code class="xref py py-obj docutils literal notranslate"><span class="pre">subtract</span></code></a>(x, y, *[, memory_pool])</p></td> |
| <td><p>Substract the arguments element-wise.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.compute.subtract_checked.html#pyarrow.compute.subtract_checked" title="pyarrow.compute.subtract_checked"><code class="xref py py-obj docutils literal notranslate"><span class="pre">subtract_checked</span></code></a>(x, y, *[, memory_pool])</p></td> |
| <td><p>Substract the arguments element-wise.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.compute.power.html#pyarrow.compute.power" title="pyarrow.compute.power"><code class="xref py py-obj docutils literal notranslate"><span class="pre">power</span></code></a>(base, exponent, *[, memory_pool])</p></td> |
| <td><p>Raise arguments to power element-wise.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.compute.power_checked.html#pyarrow.compute.power_checked" title="pyarrow.compute.power_checked"><code class="xref py py-obj docutils literal notranslate"><span class="pre">power_checked</span></code></a>(base, exponent, *[, memory_pool])</p></td> |
| <td><p>Raise arguments to power element-wise.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="section" id="comparisons"> |
| <h2>Comparisons<a class="headerlink" href="#comparisons" title="Permalink to this headline">¶</a></h2> |
| <p>These functions expect two inputs of the same type. If one of the inputs is <cite>null</cite> |
| they return <code class="docutils literal notranslate"><span class="pre">null</span></code>.</p> |
| <table class="longtable table autosummary"> |
| <colgroup> |
| <col style="width: 10%" /> |
| <col style="width: 90%" /> |
| </colgroup> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.compute.equal.html#pyarrow.compute.equal" title="pyarrow.compute.equal"><code class="xref py py-obj docutils literal notranslate"><span class="pre">equal</span></code></a>(x, y, *[, memory_pool])</p></td> |
| <td><p>Compare values for equality (x == y).</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.compute.greater.html#pyarrow.compute.greater" title="pyarrow.compute.greater"><code class="xref py py-obj docutils literal notranslate"><span class="pre">greater</span></code></a>(x, y, *[, memory_pool])</p></td> |
| <td><p>Compare values for ordered inequality (x > y).</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.compute.greater_equal.html#pyarrow.compute.greater_equal" title="pyarrow.compute.greater_equal"><code class="xref py py-obj docutils literal notranslate"><span class="pre">greater_equal</span></code></a>(x, y, *[, memory_pool])</p></td> |
| <td><p>Compare values for ordered inequality (x >= y).</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.compute.less.html#pyarrow.compute.less" title="pyarrow.compute.less"><code class="xref py py-obj docutils literal notranslate"><span class="pre">less</span></code></a>(x, y, *[, memory_pool])</p></td> |
| <td><p>Compare values for ordered inequality (x < y).</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.compute.less_equal.html#pyarrow.compute.less_equal" title="pyarrow.compute.less_equal"><code class="xref py py-obj docutils literal notranslate"><span class="pre">less_equal</span></code></a>(x, y, *[, memory_pool])</p></td> |
| <td><p>Compare values for ordered inequality (x <= y).</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.compute.not_equal.html#pyarrow.compute.not_equal" title="pyarrow.compute.not_equal"><code class="xref py py-obj docutils literal notranslate"><span class="pre">not_equal</span></code></a>(x, y, *[, memory_pool])</p></td> |
| <td><p>Compare values for inequality (x != y).</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="section" id="logical-functions"> |
| <h2>Logical Functions<a class="headerlink" href="#logical-functions" title="Permalink to this headline">¶</a></h2> |
| <p>These functions normally emit a null when one of the inputs is null. However, Kleene |
| logic variants are provided (suffixed <code class="docutils literal notranslate"><span class="pre">_kleene</span></code>). See User Guide for details.</p> |
| <table class="longtable table autosummary"> |
| <colgroup> |
| <col style="width: 10%" /> |
| <col style="width: 90%" /> |
| </colgroup> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.compute.and_.html#pyarrow.compute.and_" title="pyarrow.compute.and_"><code class="xref py py-obj docutils literal notranslate"><span class="pre">and_</span></code></a>(x, y, *[, memory_pool])</p></td> |
| <td><p>Logical ‘and’ boolean values.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.compute.and_kleene.html#pyarrow.compute.and_kleene" title="pyarrow.compute.and_kleene"><code class="xref py py-obj docutils literal notranslate"><span class="pre">and_kleene</span></code></a>(x, y, *[, memory_pool])</p></td> |
| <td><p>Logical ‘and’ boolean values (Kleene logic).</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.compute.all.html#pyarrow.compute.all" title="pyarrow.compute.all"><code class="xref py py-obj docutils literal notranslate"><span class="pre">all</span></code></a>(array, *[, memory_pool])</p></td> |
| <td><p>Test whether all elements in a boolean array evaluate to true.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.compute.any.html#pyarrow.compute.any" title="pyarrow.compute.any"><code class="xref py py-obj docutils literal notranslate"><span class="pre">any</span></code></a>(array, *[, memory_pool])</p></td> |
| <td><p>Test whether any element in a boolean array evaluates to true.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.compute.invert.html#pyarrow.compute.invert" title="pyarrow.compute.invert"><code class="xref py py-obj docutils literal notranslate"><span class="pre">invert</span></code></a>(values, *[, memory_pool])</p></td> |
| <td><p>Invert boolean values.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.compute.or_.html#pyarrow.compute.or_" title="pyarrow.compute.or_"><code class="xref py py-obj docutils literal notranslate"><span class="pre">or_</span></code></a>(x, y, *[, memory_pool])</p></td> |
| <td><p>Logical ‘or’ boolean values.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.compute.or_kleene.html#pyarrow.compute.or_kleene" title="pyarrow.compute.or_kleene"><code class="xref py py-obj docutils literal notranslate"><span class="pre">or_kleene</span></code></a>(x, y, *[, memory_pool])</p></td> |
| <td><p>Logical ‘or’ boolean values (Kleene logic).</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.compute.xor.html#pyarrow.compute.xor" title="pyarrow.compute.xor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">xor</span></code></a>(x, y, *[, memory_pool])</p></td> |
| <td><p>Logical ‘xor’ boolean values.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="section" id="string-predicates"> |
| <h2>String Predicates<a class="headerlink" href="#string-predicates" title="Permalink to this headline">¶</a></h2> |
| <p>In these functions an empty string emits false in the output. For ASCII |
| variants (prefixed <code class="docutils literal notranslate"><span class="pre">ascii_</span></code>) a string element with non-ASCII characters |
| emits false in the output.</p> |
| <p>The first set of functions emit true if the input contains only |
| characters of a given class.</p> |
| <table class="longtable table autosummary"> |
| <colgroup> |
| <col style="width: 10%" /> |
| <col style="width: 90%" /> |
| </colgroup> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.compute.ascii_is_alnum.html#pyarrow.compute.ascii_is_alnum" title="pyarrow.compute.ascii_is_alnum"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ascii_is_alnum</span></code></a>(strings, *[, memory_pool])</p></td> |
| <td><p>Classify strings as ASCII alphanumeric.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.compute.ascii_is_alpha.html#pyarrow.compute.ascii_is_alpha" title="pyarrow.compute.ascii_is_alpha"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ascii_is_alpha</span></code></a>(strings, *[, memory_pool])</p></td> |
| <td><p>Classify strings as ASCII alphabetic.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.compute.ascii_is_decimal.html#pyarrow.compute.ascii_is_decimal" title="pyarrow.compute.ascii_is_decimal"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ascii_is_decimal</span></code></a>(strings, *[, memory_pool])</p></td> |
| <td><p>Classify strings as ASCII decimal.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.compute.ascii_is_lower.html#pyarrow.compute.ascii_is_lower" title="pyarrow.compute.ascii_is_lower"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ascii_is_lower</span></code></a>(strings, *[, memory_pool])</p></td> |
| <td><p>Classify strings as ASCII lowercase.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.compute.ascii_is_printable.html#pyarrow.compute.ascii_is_printable" title="pyarrow.compute.ascii_is_printable"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ascii_is_printable</span></code></a>(strings, *[, memory_pool])</p></td> |
| <td><p>Classify strings as ASCII printable.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.compute.ascii_is_space.html#pyarrow.compute.ascii_is_space" title="pyarrow.compute.ascii_is_space"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ascii_is_space</span></code></a>(strings, *[, memory_pool])</p></td> |
| <td><p>Classify strings as ASCII whitespace.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.compute.ascii_is_upper.html#pyarrow.compute.ascii_is_upper" title="pyarrow.compute.ascii_is_upper"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ascii_is_upper</span></code></a>(strings, *[, memory_pool])</p></td> |
| <td><p>Classify strings as ASCII uppercase.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.compute.utf8_is_alnum.html#pyarrow.compute.utf8_is_alnum" title="pyarrow.compute.utf8_is_alnum"><code class="xref py py-obj docutils literal notranslate"><span class="pre">utf8_is_alnum</span></code></a>(strings, *[, memory_pool])</p></td> |
| <td><p>Classify strings as alphanumeric.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.compute.utf8_is_alpha.html#pyarrow.compute.utf8_is_alpha" title="pyarrow.compute.utf8_is_alpha"><code class="xref py py-obj docutils literal notranslate"><span class="pre">utf8_is_alpha</span></code></a>(strings, *[, memory_pool])</p></td> |
| <td><p>Classify strings as alphabetic.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.compute.utf8_is_decimal.html#pyarrow.compute.utf8_is_decimal" title="pyarrow.compute.utf8_is_decimal"><code class="xref py py-obj docutils literal notranslate"><span class="pre">utf8_is_decimal</span></code></a>(strings, *[, memory_pool])</p></td> |
| <td><p>Classify strings as decimal.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.compute.utf8_is_digit.html#pyarrow.compute.utf8_is_digit" title="pyarrow.compute.utf8_is_digit"><code class="xref py py-obj docutils literal notranslate"><span class="pre">utf8_is_digit</span></code></a>(strings, *[, memory_pool])</p></td> |
| <td><p>Classify strings as digits.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.compute.utf8_is_lower.html#pyarrow.compute.utf8_is_lower" title="pyarrow.compute.utf8_is_lower"><code class="xref py py-obj docutils literal notranslate"><span class="pre">utf8_is_lower</span></code></a>(strings, *[, memory_pool])</p></td> |
| <td><p>Classify strings as lowercase.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.compute.utf8_is_numeric.html#pyarrow.compute.utf8_is_numeric" title="pyarrow.compute.utf8_is_numeric"><code class="xref py py-obj docutils literal notranslate"><span class="pre">utf8_is_numeric</span></code></a>(strings, *[, memory_pool])</p></td> |
| <td><p>Classify strings as numeric.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.compute.utf8_is_printable.html#pyarrow.compute.utf8_is_printable" title="pyarrow.compute.utf8_is_printable"><code class="xref py py-obj docutils literal notranslate"><span class="pre">utf8_is_printable</span></code></a>(strings, *[, memory_pool])</p></td> |
| <td><p>Classify strings as printable.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.compute.utf8_is_space.html#pyarrow.compute.utf8_is_space" title="pyarrow.compute.utf8_is_space"><code class="xref py py-obj docutils literal notranslate"><span class="pre">utf8_is_space</span></code></a>(strings, *[, memory_pool])</p></td> |
| <td><p>Classify strings as whitespace.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.compute.utf8_is_upper.html#pyarrow.compute.utf8_is_upper" title="pyarrow.compute.utf8_is_upper"><code class="xref py py-obj docutils literal notranslate"><span class="pre">utf8_is_upper</span></code></a>(strings, *[, memory_pool])</p></td> |
| <td><p>Classify strings as uppercase.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <p>The second set of functions also consider the order of characters |
| in the string element.</p> |
| <table class="longtable table autosummary"> |
| <colgroup> |
| <col style="width: 10%" /> |
| <col style="width: 90%" /> |
| </colgroup> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.compute.ascii_is_title.html#pyarrow.compute.ascii_is_title" title="pyarrow.compute.ascii_is_title"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ascii_is_title</span></code></a>(strings, *[, memory_pool])</p></td> |
| <td><p>Classify strings as ASCII titlecase.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.compute.utf8_is_title.html#pyarrow.compute.utf8_is_title" title="pyarrow.compute.utf8_is_title"><code class="xref py py-obj docutils literal notranslate"><span class="pre">utf8_is_title</span></code></a>(strings, *[, memory_pool])</p></td> |
| <td><p>Classify strings as titlecase.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <p>The third set of functions examines string elements on |
| a byte-by-byte basis.</p> |
| <table class="longtable table autosummary"> |
| <colgroup> |
| <col style="width: 10%" /> |
| <col style="width: 90%" /> |
| </colgroup> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.compute.string_is_ascii.html#pyarrow.compute.string_is_ascii" title="pyarrow.compute.string_is_ascii"><code class="xref py py-obj docutils literal notranslate"><span class="pre">string_is_ascii</span></code></a>(strings, *[, memory_pool])</p></td> |
| <td><p>Classify strings as ASCII.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="section" id="string-transforms"> |
| <h2>String Transforms<a class="headerlink" href="#string-transforms" title="Permalink to this headline">¶</a></h2> |
| <table class="longtable table autosummary"> |
| <colgroup> |
| <col style="width: 10%" /> |
| <col style="width: 90%" /> |
| </colgroup> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.compute.ascii_lower.html#pyarrow.compute.ascii_lower" title="pyarrow.compute.ascii_lower"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ascii_lower</span></code></a>(strings, *[, memory_pool])</p></td> |
| <td><p>Transform ASCII input to lowercase.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.compute.ascii_upper.html#pyarrow.compute.ascii_upper" title="pyarrow.compute.ascii_upper"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ascii_upper</span></code></a>(strings, *[, memory_pool])</p></td> |
| <td><p>Transform ASCII input to uppercase.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.compute.utf8_lower.html#pyarrow.compute.utf8_lower" title="pyarrow.compute.utf8_lower"><code class="xref py py-obj docutils literal notranslate"><span class="pre">utf8_lower</span></code></a>(strings, *[, memory_pool])</p></td> |
| <td><p>Transform input to lowercase.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.compute.utf8_upper.html#pyarrow.compute.utf8_upper" title="pyarrow.compute.utf8_upper"><code class="xref py py-obj docutils literal notranslate"><span class="pre">utf8_upper</span></code></a>(strings, *[, memory_pool])</p></td> |
| <td><p>Transform input to uppercase.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="section" id="containment-tests"> |
| <h2>Containment tests<a class="headerlink" href="#containment-tests" title="Permalink to this headline">¶</a></h2> |
| <table class="longtable table autosummary"> |
| <colgroup> |
| <col style="width: 10%" /> |
| <col style="width: 90%" /> |
| </colgroup> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.compute.index_in.html#pyarrow.compute.index_in" title="pyarrow.compute.index_in"><code class="xref py py-obj docutils literal notranslate"><span class="pre">index_in</span></code></a>(values, *[, options, memory_pool])</p></td> |
| <td><p>Return index of each element in a set of values.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.compute.is_in.html#pyarrow.compute.is_in" title="pyarrow.compute.is_in"><code class="xref py py-obj docutils literal notranslate"><span class="pre">is_in</span></code></a>(values, *[, options, memory_pool])</p></td> |
| <td><p>Find each element in a set of values.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.compute.match_substring.html#pyarrow.compute.match_substring" title="pyarrow.compute.match_substring"><code class="xref py py-obj docutils literal notranslate"><span class="pre">match_substring</span></code></a>(array, pattern)</p></td> |
| <td><p>Test if substring <em>pattern</em> is contained within a value of a string array.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.compute.match_substring_regex.html#pyarrow.compute.match_substring_regex" title="pyarrow.compute.match_substring_regex"><code class="xref py py-obj docutils literal notranslate"><span class="pre">match_substring_regex</span></code></a>(array, pattern)</p></td> |
| <td><p>Test if regex <em>pattern</em> matches at any position a value of a string array.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="section" id="conversions"> |
| <h2>Conversions<a class="headerlink" href="#conversions" title="Permalink to this headline">¶</a></h2> |
| <table class="longtable table autosummary"> |
| <colgroup> |
| <col style="width: 10%" /> |
| <col style="width: 90%" /> |
| </colgroup> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.compute.cast.html#pyarrow.compute.cast" title="pyarrow.compute.cast"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cast</span></code></a>(arr, target_type[, safe])</p></td> |
| <td><p>Cast array values to another data type.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.compute.strptime.html#pyarrow.compute.strptime" title="pyarrow.compute.strptime"><code class="xref py py-obj docutils literal notranslate"><span class="pre">strptime</span></code></a>(strings, *[, options, memory_pool])</p></td> |
| <td><p>Parse timestamps.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="section" id="selections"> |
| <h2>Selections<a class="headerlink" href="#selections" title="Permalink to this headline">¶</a></h2> |
| <table class="longtable table autosummary"> |
| <colgroup> |
| <col style="width: 10%" /> |
| <col style="width: 90%" /> |
| </colgroup> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.compute.filter.html#pyarrow.compute.filter" title="pyarrow.compute.filter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">filter</span></code></a>(data, mask[, null_selection_behavior])</p></td> |
| <td><p>Select values (or records) from array- or table-like data given boolean filter, where true values are selected.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.compute.take.html#pyarrow.compute.take" title="pyarrow.compute.take"><code class="xref py py-obj docutils literal notranslate"><span class="pre">take</span></code></a>(data, indices, *[, boundscheck, …])</p></td> |
| <td><p>Select values (or records) from array- or table-like data given integer selection indices.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="section" id="associative-transforms"> |
| <h2>Associative transforms<a class="headerlink" href="#associative-transforms" title="Permalink to this headline">¶</a></h2> |
| <table class="longtable table autosummary"> |
| <colgroup> |
| <col style="width: 10%" /> |
| <col style="width: 90%" /> |
| </colgroup> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.compute.dictionary_encode.html#pyarrow.compute.dictionary_encode" title="pyarrow.compute.dictionary_encode"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dictionary_encode</span></code></a>(array, *[, options, …])</p></td> |
| <td><p>Dictionary-encode array.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.compute.unique.html#pyarrow.compute.unique" title="pyarrow.compute.unique"><code class="xref py py-obj docutils literal notranslate"><span class="pre">unique</span></code></a>(array, *[, memory_pool])</p></td> |
| <td><p>Compute unique elements.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.compute.value_counts.html#pyarrow.compute.value_counts" title="pyarrow.compute.value_counts"><code class="xref py py-obj docutils literal notranslate"><span class="pre">value_counts</span></code></a>(array, *[, memory_pool])</p></td> |
| <td><p>Compute counts of unique elements.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="section" id="sorts-and-partitions"> |
| <h2>Sorts and partitions<a class="headerlink" href="#sorts-and-partitions" title="Permalink to this headline">¶</a></h2> |
| <table class="longtable table autosummary"> |
| <colgroup> |
| <col style="width: 10%" /> |
| <col style="width: 90%" /> |
| </colgroup> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.compute.partition_nth_indices.html#pyarrow.compute.partition_nth_indices" title="pyarrow.compute.partition_nth_indices"><code class="xref py py-obj docutils literal notranslate"><span class="pre">partition_nth_indices</span></code></a>(array, *[, options, …])</p></td> |
| <td><p>Return the indices that would partition an array around a pivot.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.compute.sort_indices.html#pyarrow.compute.sort_indices" title="pyarrow.compute.sort_indices"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sort_indices</span></code></a>(input, *[, options, memory_pool])</p></td> |
| <td><p>Return the indices that would sort an array, record batch or table.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="section" id="structural-transforms"> |
| <h2>Structural Transforms<a class="headerlink" href="#structural-transforms" title="Permalink to this headline">¶</a></h2> |
| <table class="longtable table autosummary"> |
| <colgroup> |
| <col style="width: 10%" /> |
| <col style="width: 90%" /> |
| </colgroup> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.compute.binary_length.html#pyarrow.compute.binary_length" title="pyarrow.compute.binary_length"><code class="xref py py-obj docutils literal notranslate"><span class="pre">binary_length</span></code></a>(strings, *[, memory_pool])</p></td> |
| <td><p>Compute string lengths.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.compute.fill_null.html#pyarrow.compute.fill_null" title="pyarrow.compute.fill_null"><code class="xref py py-obj docutils literal notranslate"><span class="pre">fill_null</span></code></a>(values, fill_value)</p></td> |
| <td><p>Replace each null element in values with fill_value.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.compute.is_null.html#pyarrow.compute.is_null" title="pyarrow.compute.is_null"><code class="xref py py-obj docutils literal notranslate"><span class="pre">is_null</span></code></a>(values, *[, memory_pool])</p></td> |
| <td><p>Return true if null.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.compute.is_valid.html#pyarrow.compute.is_valid" title="pyarrow.compute.is_valid"><code class="xref py py-obj docutils literal notranslate"><span class="pre">is_valid</span></code></a>(values, *[, memory_pool])</p></td> |
| <td><p>Return true if non-null.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.compute.list_value_length.html#pyarrow.compute.list_value_length" title="pyarrow.compute.list_value_length"><code class="xref py py-obj docutils literal notranslate"><span class="pre">list_value_length</span></code></a>(lists, *[, memory_pool])</p></td> |
| <td><p>Compute list lengths.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.compute.list_flatten.html#pyarrow.compute.list_flatten" title="pyarrow.compute.list_flatten"><code class="xref py py-obj docutils literal notranslate"><span class="pre">list_flatten</span></code></a>(lists, *[, memory_pool])</p></td> |
| <td><p>Flatten list values.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.compute.list_parent_indices.html#pyarrow.compute.list_parent_indices" title="pyarrow.compute.list_parent_indices"><code class="xref py py-obj docutils literal notranslate"><span class="pre">list_parent_indices</span></code></a>(lists, *[, memory_pool])</p></td> |
| <td><p>Compute parent indices of nested list values.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| |
| |
| </div> |
| |
| |
| <div class='prev-next-bottom'> |
| |
| <a class='left-prev' id="prev-link" href="../generated/pyarrow.total_allocated_bytes.html" title="previous page">pyarrow.total_allocated_bytes</a> |
| <a class='right-next' id="next-link" href="../generated/pyarrow.compute.count.html" title="next page">pyarrow.compute.count</a> |
| |
| </div> |
| |
| </main> |
| |
| |
| </div> |
| </div> |
| |
| <script src="../../_static/js/index.1c5a1a01449ed65a7b51.js"></script> |
| |
| |
| <!-- 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 --> |
| <footer class="footer mt-5 mt-md-0"> |
| <div class="container"> |
| |
| <div class="footer-item"> |
| <p class="copyright"> |
| © Copyright 2016-2019 Apache Software Foundation.<br/> |
| </p> |
| </div> |
| |
| <div class="footer-item"> |
| <p class="sphinx-version"> |
| Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.0.2.<br/> |
| </p> |
| </div> |
| |
| </div> |
| </footer> |
| <script type="text/javascript" src="/docs/_static/versionwarning.js"></script> </body> |
| </html> |
