Morph MORPH
SIGN IN SIGN UP
apache / arrow UNCLAIMED

Apache Arrow is the universal columnar format and multi-language toolbox for fast data interchange and in-memory analytics

0 0 16 C++
Normal View History Raw
ARROW-9967: [Python] Add compute module docs + expose more option classes #8163 exposes `pyarrow.compute` kernels and generates their docstrings. This PR adds documentation for the module in the User Guide and the Python API reference. Closes #8145 from arw2019/ARROW-7871 Lead-authored-by: arw2019 <andrew.r.wieteska@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2020-10-08 14:57:58 +02:00
.. Licensed to the Apache Software Foundation (ASF) under one
.. or more contributor license agreements. See the NOTICE file
.. distributed with this work for additional information
.. regarding copyright ownership. The ASF licenses this file
.. to you under the Apache License, Version 2.0 (the
.. "License"); you may not use this file except in compliance
.. with the License. You may obtain a copy of the License at
.. http://www.apache.org/licenses/LICENSE-2.0
.. Unless required by applicable law or agreed to in writing,
.. software distributed under the License is distributed on an
.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
.. KIND, either express or implied. See the License for the
.. specific language governing permissions and limitations
.. under the License.
.. _api.compute:
.. currentmodule:: pyarrow.compute
Compute Functions
=================
Aggregations
------------
.. autosummary::
:toctree: ../generated/
ARROW-14012: [Python] Update kernel categories in compute doc to match C++ Update lists of compute kernels in Python and C++ documentation. Closes #11237 from edponce/ARROW-14012-Update-kernel-categories-in-compute-doc- Authored-by: Eduardo Ponce <edponce00@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-27 18:29:09 +02:00
all
any
ARROW-14052: [C++] Add approximate_median aggregation This wraps the tdigest aggregation to make it easier for bindings to use. This PR is on top of ARROW-14050 (#11199). Closes #11204 from lidavidm/arrow-14052 Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: David Li <li.davidm96@gmail.com>
2021-09-24 09:01:46 -04:00
approximate_median
ARROW-9967: [Python] Add compute module docs + expose more option classes #8163 exposes `pyarrow.compute` kernels and generates their docstrings. This PR adds documentation for the module in the User Guide and the Python API reference. Closes #8145 from arw2019/ARROW-7871 Lead-authored-by: arw2019 <andrew.r.wieteska@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2020-10-08 14:57:58 +02:00
count
ARROW-14035: [C++][Python][R] Implement count distinct kernel https://issues.apache.org/jira/browse/ARROW-14035 Closes #11257 from aucahuasi/ARROW-14035-implement-count_distinct-kernel Lead-authored-by: Percy Camilo Triveño Aucahuasi <percy.camilo.ta@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Neal Richardson <neal.p.richardson@gmail.com>
2021-10-05 10:22:38 -04:00
count_distinct
GH-48095: [Python][Docs] Add missing {pyarrow,compute} functions to API docs (#48117) Issue #48095 and #45322 ### Rationale for this change Missing API doc entries. ### What changes are included in this PR? I've added strings for functions and options to the API doc page. ### Are these changes tested? I've built docs locally. ### Are there any user-facing changes? Docs only. * GitHub Issue: #48095 * Also covers: #45322 Lead-authored-by: Tadeja Kadunc <tadeja.kadunc@gmail.com> Co-authored-by: tadeja <tadeja@users.noreply.github.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Signed-off-by: AlenkaF <frim.alenka@gmail.com>
2025-11-20 12:35:31 +01:00
first
first_last
ARROW-2665: [C++][Python] Add index() kernel Add a simple index() kernel. Note that the Python start/end options are handled entirely in Python, not in the kernel itself. Short-circuiting is somewhat implemented: the kernel executor will still loop through all batches but the kernel will stop looking at data once it finds an item. Closes #10358 from lidavidm/arrow-2665 Lead-authored-by: David Li <li.davidm96@gmail.com> Co-authored-by: Yibo Cai <yibo.cai@arm.com> Signed-off-by: Yibo Cai <yibo.cai@arm.com>
2021-05-22 21:39:04 +08:00
index
GH-48095: [Python][Docs] Add missing {pyarrow,compute} functions to API docs (#48117) Issue #48095 and #45322 ### Rationale for this change Missing API doc entries. ### What changes are included in this PR? I've added strings for functions and options to the API doc page. ### Are these changes tested? I've built docs locally. ### Are there any user-facing changes? Docs only. * GitHub Issue: #48095 * Also covers: #45322 Lead-authored-by: Tadeja Kadunc <tadeja.kadunc@gmail.com> Co-authored-by: tadeja <tadeja@users.noreply.github.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Signed-off-by: AlenkaF <frim.alenka@gmail.com>
2025-11-20 12:35:31 +01:00
kurtosis
last
ARROW-14052: [C++] Add approximate_median aggregation This wraps the tdigest aggregation to make it easier for bindings to use. This PR is on top of ARROW-14050 (#11199). Closes #11204 from lidavidm/arrow-14052 Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: David Li <li.davidm96@gmail.com>
2021-09-24 09:01:46 -04:00
max
ARROW-9967: [Python] Add compute module docs + expose more option classes #8163 exposes `pyarrow.compute` kernels and generates their docstrings. This PR adds documentation for the module in the User Guide and the Python API reference. Closes #8145 from arw2019/ARROW-7871 Lead-authored-by: arw2019 <andrew.r.wieteska@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2020-10-08 14:57:58 +02:00
mean
ARROW-14052: [C++] Add approximate_median aggregation This wraps the tdigest aggregation to make it easier for bindings to use. This PR is on top of ARROW-14050 (#11199). Closes #11204 from lidavidm/arrow-14052 Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: David Li <li.davidm96@gmail.com>
2021-09-24 09:01:46 -04:00
min
ARROW-9967: [Python] Add compute module docs + expose more option classes #8163 exposes `pyarrow.compute` kernels and generates their docstrings. This PR adds documentation for the module in the User Guide and the Python API reference. Closes #8145 from arw2019/ARROW-7871 Lead-authored-by: arw2019 <andrew.r.wieteska@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2020-10-08 14:57:58 +02:00
min_max
mode
GH-45269: [C++][Compute] Add "pivot_wider" and "hash_pivot_wider" functions (#45562) ### Rationale for this change Add "pivot wider" functionality such as [in Pandas](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.pivot.html), through two dedicated functions: 1. a "pivot_wider" scalar aggregate function returning a Struct scalar 2. a "hash_pivot_wider" grouped aggregate function returning a Struct array Both functions take two arguments (the column of pivot keys and the column of pivot values) and require passing a `PivotWiderOptions` structure with the expected pivot keys, so as to determine the output Struct type. ### Are these changes tested? Yes, by dedicated unit tests. ### Are there any user-facing changes? No, just new APIs. * GitHub Issue: #45269 Authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2025-03-04 17:21:38 +01:00
pivot_wider
ARROW-13575: [C++] Add hash_product kernel Closes #10890 from lidavidm/arrow-13575 Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-08-10 17:02:52 +02:00
product
ARROW-14052: [C++] Add approximate_median aggregation This wraps the tdigest aggregation to make it easier for bindings to use. This PR is on top of ARROW-14050 (#11199). Closes #11204 from lidavidm/arrow-14052 Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: David Li <li.davidm96@gmail.com>
2021-09-24 09:01:46 -04:00
quantile
GH-48095: [Python][Docs] Add missing {pyarrow,compute} functions to API docs (#48117) Issue #48095 and #45322 ### Rationale for this change Missing API doc entries. ### What changes are included in this PR? I've added strings for functions and options to the API doc page. ### Are these changes tested? I've built docs locally. ### Are there any user-facing changes? Docs only. * GitHub Issue: #48095 * Also covers: #45322 Lead-authored-by: Tadeja Kadunc <tadeja.kadunc@gmail.com> Co-authored-by: tadeja <tadeja@users.noreply.github.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Signed-off-by: AlenkaF <frim.alenka@gmail.com>
2025-11-20 12:35:31 +01:00
skew
ARROW-9967: [Python] Add compute module docs + expose more option classes #8163 exposes `pyarrow.compute` kernels and generates their docstrings. This PR adds documentation for the module in the User Guide and the Python API reference. Closes #8145 from arw2019/ARROW-7871 Lead-authored-by: arw2019 <andrew.r.wieteska@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2020-10-08 14:57:58 +02:00
stddev
sum
ARROW-14052: [C++] Add approximate_median aggregation This wraps the tdigest aggregation to make it easier for bindings to use. This PR is on top of ARROW-14050 (#11199). Closes #11204 from lidavidm/arrow-14052 Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: David Li <li.davidm96@gmail.com>
2021-09-24 09:01:46 -04:00
tdigest
ARROW-9967: [Python] Add compute module docs + expose more option classes #8163 exposes `pyarrow.compute` kernels and generates their docstrings. This PR adds documentation for the module in the User Guide and the Python API reference. Closes #8145 from arw2019/ARROW-7871 Lead-authored-by: arw2019 <andrew.r.wieteska@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2020-10-08 14:57:58 +02:00
variance
GH-33566: [C++] Add support for nullary and n-ary aggregate functions (#15083) - [x] Add ability to pass 0 or more than 1 target fields via the Aggregate API - [x] Add support for nullary `count` -- `count(*)` - [x] Add a n-ary aggregate function to test changes `*` `*` I implemented a `"covariant(y, x)"` aggregation function and used it to test the Aggregate API changes, but it's not present in this PR now that I intend to focus on passing the CI tests and get a final review * Closes: #33566 Lead-authored-by: Felipe Oliveira Carvalho <felipekde@gmail.com> Co-authored-by: Antoine Pitrou <pitrou@free.fr> Co-authored-by: Weston Pace <weston.pace@gmail.com> Signed-off-by: Weston Pace <weston.pace@gmail.com>
2023-01-26 14:01:01 -03:00
..
Nullary aggregate functions (count_all) aren't exposed in pyarrow.compute,
so they aren't listed here.
ARROW-13530: [C++] Implement cumulative sum compute function Creating new compute function to perform a cumulative sum on a given array/vector. Closes #12460 from JabariBooker/ARROW-13530 Lead-authored-by: JabariBooker <o.jabari.booker@gmail.com> Co-authored-by: Eduardo Ponce <edponce00@gmail.com> Co-authored-by: Jabari Booker <o.jabari.booker@gmail.com> Co-authored-by: Jabari Booker <booker.oronde@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2022-05-31 15:23:09 +02:00
Cumulative Functions
--------------------
GH-39990: [Docs][CI] Add sphinx-lint for docs linting (#40022) ### What changes are included in this PR? This adds developer tooling to the repo for linting the docs by adding the sphinx-lint tool to archery and our pre-commit hooks. In both locations, only two rules are enabled at the moment (Discussed in https://github.com/apache/arrow/pull/40006): `trailing-whitespace` and `missing-final-newline`. This PR also fixes the individual issues covered by the new tooling. ### Are these changes tested? Yes, though manually. I tested this works by running `archery lint --docs` and `pre-commit` without and without changes that should get caught by the rules. It works as expected. ### Are there any user-facing changes? Yes, 1. Developers that use pre-commit hooks will see a change in behavior when they modify docs 2. Developers using archery will see a new --docs option in `archery lint` 3. Developers working on the docs may see CI failures related to the new checks * Closes: #39990 * GitHub Issue: #39990 Authored-by: Bryce Mecum <petridish@gmail.com> Signed-off-by: Bryce Mecum <petridish@gmail.com>
2024-04-30 17:27:26 -08:00
Cumulative functions are vector functions that perform a running accumulation on
their input using a given binary associative operation with an identity element
(a monoid) and output an array containing the corresponding intermediate running
values. The input is expected to be of numeric type. By default these functions
GH-32190: [C++][Compute] Implement cumulative prod, max and min functions (#36020) ### Rationale for this change Implement cumulative prod, max and min compute functions ### What changes are included in this PR? 1. Add implementations, docs and tests for the three functions. 2. Refactor `CumulativeSumOptions` to `CumulativeOptions` for reusability. 3. Fix a bug where `GenericFromScalar(GenericToScalar(std::nullopt)) != std::nullopt`. 4. Remove an unnecessary Cast with the default start value. 5. Add tests to check behavior with `NaN`. I'll explain some of the changes in comments. ### Are these changes tested? Yes, in vector_accumulative_ops_test.cc and test_compute.py ### Are there any user-facing changes? No. The data members of `CumulativeSumOptions` are changed, but the member functions behave as before. And std::optional<T> also can be constructed directly from T. So users should not feel any difference. * Closes: #32190 Lead-authored-by: Jin Shang <shangjin1997@gmail.com> Co-authored-by: Benjamin Kietzman <bengilgit@gmail.com> Signed-off-by: Benjamin Kietzman <bengilgit@gmail.com>
2023-06-23 00:03:16 +08:00
do not detect overflow. They are also
ARROW-13530: [C++] Implement cumulative sum compute function Creating new compute function to perform a cumulative sum on a given array/vector. Closes #12460 from JabariBooker/ARROW-13530 Lead-authored-by: JabariBooker <o.jabari.booker@gmail.com> Co-authored-by: Eduardo Ponce <edponce00@gmail.com> Co-authored-by: Jabari Booker <o.jabari.booker@gmail.com> Co-authored-by: Jabari Booker <booker.oronde@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2022-05-31 15:23:09 +02:00
available in an overflow-checking variant, suffixed ``_checked``, which
throws an ``ArrowInvalid`` exception when overflow is detected.
.. autosummary::
:toctree: ../generated/
cumulative_sum
cumulative_sum_checked
GH-32190: [C++][Compute] Implement cumulative prod, max and min functions (#36020) ### Rationale for this change Implement cumulative prod, max and min compute functions ### What changes are included in this PR? 1. Add implementations, docs and tests for the three functions. 2. Refactor `CumulativeSumOptions` to `CumulativeOptions` for reusability. 3. Fix a bug where `GenericFromScalar(GenericToScalar(std::nullopt)) != std::nullopt`. 4. Remove an unnecessary Cast with the default start value. 5. Add tests to check behavior with `NaN`. I'll explain some of the changes in comments. ### Are these changes tested? Yes, in vector_accumulative_ops_test.cc and test_compute.py ### Are there any user-facing changes? No. The data members of `CumulativeSumOptions` are changed, but the member functions behave as before. And std::optional<T> also can be constructed directly from T. So users should not feel any difference. * Closes: #32190 Lead-authored-by: Jin Shang <shangjin1997@gmail.com> Co-authored-by: Benjamin Kietzman <bengilgit@gmail.com> Signed-off-by: Benjamin Kietzman <bengilgit@gmail.com>
2023-06-23 00:03:16 +08:00
cumulative_prod
cumulative_prod_checked
cumulative_max
GH-48095: [Python][Docs] Add missing {pyarrow,compute} functions to API docs (#48117) Issue #48095 and #45322 ### Rationale for this change Missing API doc entries. ### What changes are included in this PR? I've added strings for functions and options to the API doc page. ### Are these changes tested? I've built docs locally. ### Are there any user-facing changes? Docs only. * GitHub Issue: #48095 * Also covers: #45322 Lead-authored-by: Tadeja Kadunc <tadeja.kadunc@gmail.com> Co-authored-by: tadeja <tadeja@users.noreply.github.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Signed-off-by: AlenkaF <frim.alenka@gmail.com>
2025-11-20 12:35:31 +01:00
cumulative_mean
GH-32190: [C++][Compute] Implement cumulative prod, max and min functions (#36020) ### Rationale for this change Implement cumulative prod, max and min compute functions ### What changes are included in this PR? 1. Add implementations, docs and tests for the three functions. 2. Refactor `CumulativeSumOptions` to `CumulativeOptions` for reusability. 3. Fix a bug where `GenericFromScalar(GenericToScalar(std::nullopt)) != std::nullopt`. 4. Remove an unnecessary Cast with the default start value. 5. Add tests to check behavior with `NaN`. I'll explain some of the changes in comments. ### Are these changes tested? Yes, in vector_accumulative_ops_test.cc and test_compute.py ### Are there any user-facing changes? No. The data members of `CumulativeSumOptions` are changed, but the member functions behave as before. And std::optional<T> also can be constructed directly from T. So users should not feel any difference. * Closes: #32190 Lead-authored-by: Jin Shang <shangjin1997@gmail.com> Co-authored-by: Benjamin Kietzman <bengilgit@gmail.com> Signed-off-by: Benjamin Kietzman <bengilgit@gmail.com>
2023-06-23 00:03:16 +08:00
cumulative_min
ARROW-13530: [C++] Implement cumulative sum compute function Creating new compute function to perform a cumulative sum on a given array/vector. Closes #12460 from JabariBooker/ARROW-13530 Lead-authored-by: JabariBooker <o.jabari.booker@gmail.com> Co-authored-by: Eduardo Ponce <edponce00@gmail.com> Co-authored-by: Jabari Booker <o.jabari.booker@gmail.com> Co-authored-by: Jabari Booker <booker.oronde@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2022-05-31 15:23:09 +02:00
ARROW-9967: [Python] Add compute module docs + expose more option classes #8163 exposes `pyarrow.compute` kernels and generates their docstrings. This PR adds documentation for the module in the User Guide and the Python API reference. Closes #8145 from arw2019/ARROW-7871 Lead-authored-by: arw2019 <andrew.r.wieteska@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2020-10-08 14:57:58 +02:00
Arithmetic Functions
--------------------
ARROW-12861: [C++][Compute] Add sign function kernels This PR adds the sign function to the compute layer as a unary scalar function. * Numeric inputs result in any of (-1,0,1) * +/-0 input returns 0 * Infinity is treated as a signed number * NaN input returns NaN Closes #10395 from edponce/ARROW-12861-Compute-Add-sign-function-kernels Authored-by: Eduardo Ponce <edponce00@gmail.com> Signed-off-by: Benjamin Kietzman <bengilgit@gmail.com>
2021-07-15 17:09:40 -04:00
By default these functions do not detect overflow. Most functions are also
ARROW-12949: [C++] Add starts_with and ends_with This adds a simple starts_with and ends_with. Also, now match_like can optimize some patterns into prefix/suffix matches. This also fixes a bug (which I believe is also present in Apache Impala) where some LIKE patterns are mistakenly optimized into suffix or substring matches. Closes #10448 from lidavidm/arrow-12949 Lead-authored-by: David Li <li.davidm96@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-06-08 12:37:56 +02:00
available in an overflow-checking variant, suffixed ``_checked``, which
ARROW-9967: [Python] Add compute module docs + expose more option classes #8163 exposes `pyarrow.compute` kernels and generates their docstrings. This PR adds documentation for the module in the User Guide and the Python API reference. Closes #8145 from arw2019/ARROW-7871 Lead-authored-by: arw2019 <andrew.r.wieteska@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2020-10-08 14:57:58 +02:00
throws an ``ArrowInvalid`` exception when overflow is detected.
.. autosummary::
:toctree: ../generated/
ARROW-12685: [C++][Compute] Add unary absolute value kernel This PR adds the arithmetic absolute value kernels to the compute layer. Closes #10274 from edponce/ARROW-12685-Compute-Add-unary-absolute-value-kernel Authored-by: Eduardo Ponce <edponce00@gmail.com> Signed-off-by: Yibo Cai <yibo.cai@arm.com>
2021-05-20 01:46:11 +00:00
abs
abs_checked
ARROW-9967: [Python] Add compute module docs + expose more option classes #8163 exposes `pyarrow.compute` kernels and generates their docstrings. This PR adds documentation for the module in the User Guide and the Python API reference. Closes #8145 from arw2019/ARROW-7871 Lead-authored-by: arw2019 <andrew.r.wieteska@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2020-10-08 14:57:58 +02:00
add
add_checked
divide
divide_checked
GH-48095: [Python][Docs] Add missing {pyarrow,compute} functions to API docs (#48117) Issue #48095 and #45322 ### Rationale for this change Missing API doc entries. ### What changes are included in this PR? I've added strings for functions and options to the API doc page. ### Are these changes tested? I've built docs locally. ### Are there any user-facing changes? Docs only. * GitHub Issue: #48095 * Also covers: #45322 Lead-authored-by: Tadeja Kadunc <tadeja.kadunc@gmail.com> Co-authored-by: tadeja <tadeja@users.noreply.github.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Signed-off-by: AlenkaF <frim.alenka@gmail.com>
2025-11-20 12:35:31 +01:00
exp
expm1
ARROW-9967: [Python] Add compute module docs + expose more option classes #8163 exposes `pyarrow.compute` kernels and generates their docstrings. This PR adds documentation for the module in the User Guide and the Python API reference. Closes #8145 from arw2019/ARROW-7871 Lead-authored-by: arw2019 <andrew.r.wieteska@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2020-10-08 14:57:58 +02:00
multiply
multiply_checked
ARROW-14012: [Python] Update kernel categories in compute doc to match C++ Update lists of compute kernels in Python and C++ documentation. Closes #11237 from edponce/ARROW-14012-Update-kernel-categories-in-compute-doc- Authored-by: Eduardo Ponce <edponce00@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-27 18:29:09 +02:00
negate
negate_checked
ARROW-11070: [C++][Compute] Implement power kernel This is to resolve [ARROW-11070](https://issues.apache.org/jira/projects/ARROW/issues/ARROW-11070). Closes #9841 from rok/ARROW-11070 Lead-authored-by: Rok <rok@mihevc.org> Co-authored-by: Yibo Cai <yibo.cai@arm.com> Signed-off-by: Neal Richardson <neal.p.richardson@gmail.com>
2021-04-13 12:46:08 -07:00
power
power_checked
ARROW-12861: [C++][Compute] Add sign function kernels This PR adds the sign function to the compute layer as a unary scalar function. * Numeric inputs result in any of (-1,0,1) * +/-0 input returns 0 * Infinity is treated as a signed number * NaN input returns NaN Closes #10395 from edponce/ARROW-12861-Compute-Add-sign-function-kernels Authored-by: Eduardo Ponce <edponce00@gmail.com> Signed-off-by: Benjamin Kietzman <bengilgit@gmail.com>
2021-07-15 17:09:40 -04:00
sign
ARROW-15614: [C++] Add sqrt binary scalar kernel This is a proposal for resolving [ARROW-15614](https://issues.apache.org/jira/browse/ARROW-15614). Tests will be added when the resolution approach is agreed Closes #12412 from rtpsw/ARROW-15614 Lead-authored-by: Yaron Gvili <rtpsw@hotmail.com> Co-authored-by: rtpsw <rtpsw@hotmail.com> Signed-off-by: David Li <li.davidm96@gmail.com>
2022-02-20 10:00:07 -05:00
sqrt
sqrt_checked
ARROW-12861: [C++][Compute] Add sign function kernels This PR adds the sign function to the compute layer as a unary scalar function. * Numeric inputs result in any of (-1,0,1) * +/-0 input returns 0 * Infinity is treated as a signed number * NaN input returns NaN Closes #10395 from edponce/ARROW-12861-Compute-Add-sign-function-kernels Authored-by: Eduardo Ponce <edponce00@gmail.com> Signed-off-by: Benjamin Kietzman <bengilgit@gmail.com>
2021-07-15 17:09:40 -04:00
subtract
subtract_checked
ARROW-13072: [C++] Add bit-wise arithmetic kernels Closes #10530 from lidavidm/arrow-13072 Lead-authored-by: David Li <li.davidm96@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-06-30 11:19:58 +02:00
ARROW-14012: [Python] Update kernel categories in compute doc to match C++ Update lists of compute kernels in Python and C++ documentation. Closes #11237 from edponce/ARROW-14012-Update-kernel-categories-in-compute-doc- Authored-by: Eduardo Ponce <edponce00@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-27 18:29:09 +02:00
Bit-wise Functions
------------------
ARROW-13072: [C++] Add bit-wise arithmetic kernels Closes #10530 from lidavidm/arrow-13072 Lead-authored-by: David Li <li.davidm96@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-06-30 11:19:58 +02:00
.. autosummary::
:toctree: ../generated/
bit_wise_and
bit_wise_not
bit_wise_or
bit_wise_xor
ARROW-14012: [Python] Update kernel categories in compute doc to match C++ Update lists of compute kernels in Python and C++ documentation. Closes #11237 from edponce/ARROW-14012-Update-kernel-categories-in-compute-doc- Authored-by: Eduardo Ponce <edponce00@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-27 18:29:09 +02:00
shift_left
shift_left_checked
shift_right
shift_right_checked
ARROW-9967: [Python] Add compute module docs + expose more option classes #8163 exposes `pyarrow.compute` kernels and generates their docstrings. This PR adds documentation for the module in the User Guide and the Python API reference. Closes #8145 from arw2019/ARROW-7871 Lead-authored-by: arw2019 <andrew.r.wieteska@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2020-10-08 14:57:58 +02:00
ARROW-12745: [C++][Compute] Add floor, ceiling, and truncate kernels This PR adds floor, ceiling, and truncate scalar kernels. For all integral inputs, output is a 64-bit floating-point value. Closes #10727 from edponce/ARROW-12745-Compute-Add-floor-ceiling-and-truncate-k Authored-by: Eduardo Ponce <edponce00@gmail.com> Signed-off-by: David Li <li.davidm96@gmail.com>
2021-07-16 15:25:58 -04:00
Rounding Functions
------------------
ARROW-12744: [C++][Compute] Add rounding kernel This PR adds rounding compute functions, namely "round" and "round_to_multiple". * `round(x, RoundOptions(ndigits, round_mode))` - round `x` to the precision indicated by `ndigits` * `round_to_multiple(x, RoundToMultipleOptions(multiple, round_mode))` - round `x` to scale of `multiple` Rounding modes supported are: DOWN, UP, TOWARDS_ZERO, TOWARDS_INFINITY, HALF_DOWN, HALF_UP, HALF_TOWARDS_ZERO, HALF_TOWARDS_INFINITY, HALF_TO_EVEN, HALF_TO_ODD. By default tie-breaking modes round to the nearest integer and resolve ties with HALF_TO_EVEN. The rounding functions expect floating-point inputs and return output of the same type. Integral inputs are implicitly type-casted and output is float64. Closes #10349 from edponce/ARROW-12744-Add-rounding-kernel Authored-by: Eduardo Ponce <edponce00@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-13 19:26:29 +02:00
Rounding functions displace numeric inputs to an approximate value with a simpler
representation based on the rounding criterion.
ARROW-12745: [C++][Compute] Add floor, ceiling, and truncate kernels This PR adds floor, ceiling, and truncate scalar kernels. For all integral inputs, output is a 64-bit floating-point value. Closes #10727 from edponce/ARROW-12745-Compute-Add-floor-ceiling-and-truncate-k Authored-by: Eduardo Ponce <edponce00@gmail.com> Signed-off-by: David Li <li.davidm96@gmail.com>
2021-07-16 15:25:58 -04:00
.. autosummary::
:toctree: ../generated/
ceil
floor
ARROW-12744: [C++][Compute] Add rounding kernel This PR adds rounding compute functions, namely "round" and "round_to_multiple". * `round(x, RoundOptions(ndigits, round_mode))` - round `x` to the precision indicated by `ndigits` * `round_to_multiple(x, RoundToMultipleOptions(multiple, round_mode))` - round `x` to scale of `multiple` Rounding modes supported are: DOWN, UP, TOWARDS_ZERO, TOWARDS_INFINITY, HALF_DOWN, HALF_UP, HALF_TOWARDS_ZERO, HALF_TOWARDS_INFINITY, HALF_TO_EVEN, HALF_TO_ODD. By default tie-breaking modes round to the nearest integer and resolve ties with HALF_TO_EVEN. The rounding functions expect floating-point inputs and return output of the same type. Integral inputs are implicitly type-casted and output is float64. Closes #10349 from edponce/ARROW-12744-Add-rounding-kernel Authored-by: Eduardo Ponce <edponce00@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-13 19:26:29 +02:00
round
GH-48095: [Python][Docs] Add missing {pyarrow,compute} functions to API docs (#48117) Issue #48095 and #45322 ### Rationale for this change Missing API doc entries. ### What changes are included in this PR? I've added strings for functions and options to the API doc page. ### Are these changes tested? I've built docs locally. ### Are there any user-facing changes? Docs only. * GitHub Issue: #48095 * Also covers: #45322 Lead-authored-by: Tadeja Kadunc <tadeja.kadunc@gmail.com> Co-authored-by: tadeja <tadeja@users.noreply.github.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Signed-off-by: AlenkaF <frim.alenka@gmail.com>
2025-11-20 12:35:31 +01:00
round_binary
ARROW-12744: [C++][Compute] Add rounding kernel This PR adds rounding compute functions, namely "round" and "round_to_multiple". * `round(x, RoundOptions(ndigits, round_mode))` - round `x` to the precision indicated by `ndigits` * `round_to_multiple(x, RoundToMultipleOptions(multiple, round_mode))` - round `x` to scale of `multiple` Rounding modes supported are: DOWN, UP, TOWARDS_ZERO, TOWARDS_INFINITY, HALF_DOWN, HALF_UP, HALF_TOWARDS_ZERO, HALF_TOWARDS_INFINITY, HALF_TO_EVEN, HALF_TO_ODD. By default tie-breaking modes round to the nearest integer and resolve ties with HALF_TO_EVEN. The rounding functions expect floating-point inputs and return output of the same type. Integral inputs are implicitly type-casted and output is float64. Closes #10349 from edponce/ARROW-12744-Add-rounding-kernel Authored-by: Eduardo Ponce <edponce00@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-13 19:26:29 +02:00
round_to_multiple
ARROW-12745: [C++][Compute] Add floor, ceiling, and truncate kernels This PR adds floor, ceiling, and truncate scalar kernels. For all integral inputs, output is a 64-bit floating-point value. Closes #10727 from edponce/ARROW-12745-Compute-Add-floor-ceiling-and-truncate-k Authored-by: Eduardo Ponce <edponce00@gmail.com> Signed-off-by: David Li <li.davidm96@gmail.com>
2021-07-16 15:25:58 -04:00
trunc
ARROW-13096: [C++] Implement logarithm compute functions Adds ln, log10, and log2. We could add a log1e and/or a logN if useful (probably not?) Has some code from/will conflict with #10544. Closes #10567 from lidavidm/arrow-13096 Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: Yibo Cai <yibo.cai@arm.com>
2021-07-07 02:46:04 +00:00
Logarithmic Functions
---------------------
Logarithmic functions are also supported, and also offer ``_checked``
variants which detect domain errors.
.. autosummary::
:toctree: ../generated/
ln
ln_checked
log10
log10_checked
log1p
log1p_checked
log2
log2_checked
ARROW-13345: [C++] Add basic implementation for log to base b Changes: - Added basic implementation for log to base b. - Added unit tests. Closes #10898 from rommelDB/13345-implement-logb-compute-function Authored-by: Rommel Quintanilla <rommel.quintanilla.c@gmail.com> Signed-off-by: David Li <li.davidm96@gmail.com>
2021-08-13 11:46:22 -04:00
logb
logb_checked
ARROW-13096: [C++] Implement logarithm compute functions Adds ln, log10, and log2. We could add a log1e and/or a logN if useful (probably not?) Has some code from/will conflict with #10544. Closes #10567 from lidavidm/arrow-13096 Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: Yibo Cai <yibo.cai@arm.com>
2021-07-07 02:46:04 +00:00
ARROW-13095: [C++] Implement trig compute functions Adds sin/cos/tan and their inverses. Checked variants check for what would be domain errors (this does not apply to atan/atan2). Closes #10544 from lidavidm/arrow-13095 Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-06-30 18:30:37 +02:00
Trigonometric Functions
-----------------------
Trigonometric functions are also supported, and also offer ``_checked``
variants which detect domain errors where appropriate.
.. autosummary::
:toctree: ../generated/
acos
acos_checked
asin
asin_checked
atan
atan2
cos
cos_checked
sin
sin_checked
tan
tan_checked
GH-48095: [Python][Docs] Add missing {pyarrow,compute} functions to API docs (#48117) Issue #48095 and #45322 ### Rationale for this change Missing API doc entries. ### What changes are included in this PR? I've added strings for functions and options to the API doc page. ### Are these changes tested? I've built docs locally. ### Are there any user-facing changes? Docs only. * GitHub Issue: #48095 * Also covers: #45322 Lead-authored-by: Tadeja Kadunc <tadeja.kadunc@gmail.com> Co-authored-by: tadeja <tadeja@users.noreply.github.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Signed-off-by: AlenkaF <frim.alenka@gmail.com>
2025-11-20 12:35:31 +01:00
Hyperbolic Trigonometric Functions
----------------------------------
Hyperbolic trigonometric functions are also supported, and, where applicable, also offer ``_checked``
variants which detect domain errors if needed.
.. autosummary::
:toctree: ../generated/
acosh
acosh_checked
asinh
atanh
atanh_checked
cosh
sinh
tanh
ARROW-9967: [Python] Add compute module docs + expose more option classes #8163 exposes `pyarrow.compute` kernels and generates their docstrings. This PR adds documentation for the module in the User Guide and the Python API reference. Closes #8145 from arw2019/ARROW-7871 Lead-authored-by: arw2019 <andrew.r.wieteska@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2020-10-08 14:57:58 +02:00
Comparisons
-----------
GH-41611: [Docs][CI] Enable most sphinx-lint rules for documentation (#41612) ### Rationale for this change https://github.com/apache/arrow/issues/41611 ### What changes are included in this PR? - Update to pre-commit config to enable all checks except `dangling-hyphen`, `line-too-long` by default - Associated fix docs ### Are these changes tested? Yes, by building and looking at the docs locally. ### Are there any user-facing changes? Just docs. * GitHub Issue: #41611 Authored-by: Bryce Mecum <petridish@gmail.com> Signed-off-by: AlenkaF <frim.alenka@gmail.com>
2024-05-16 03:30:14 -08:00
These functions expect two inputs of the same type. If one of the inputs is ``null``
ARROW-9967: [Python] Add compute module docs + expose more option classes #8163 exposes `pyarrow.compute` kernels and generates their docstrings. This PR adds documentation for the module in the User Guide and the Python API reference. Closes #8145 from arw2019/ARROW-7871 Lead-authored-by: arw2019 <andrew.r.wieteska@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2020-10-08 14:57:58 +02:00
they return ``null``.
.. autosummary::
:toctree: ../generated/
equal
greater
greater_equal
less
less_equal
not_equal
ARROW-12751: [C++] Implement minimum/maximum kernels This is a bit messy, but implements a variadic scalar maximum/minimum kernel. Closes #10390 from lidavidm/arrow-12751 Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: Benjamin Kietzman <bengilgit@gmail.com>
2021-06-03 21:40:29 -04:00
These functions take any number of arguments of a numeric or temporal type.
.. autosummary::
:toctree: ../generated/
ARROW-12709: [C++] Add binary_join_element_wise This adds a variadic scalar string join kernel, using the last argument (min 1 argument) as the separator. An options class allows emitting null (the default), skipping null non-separator arguments, or replacing null non-separator arguments with another string (mimicking libcudf). Closes #10520 from lidavidm/arrow-12709 Lead-authored-by: David Li <li.davidm96@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-06-16 20:19:27 +02:00
max_element_wise
min_element_wise
ARROW-12751: [C++] Implement minimum/maximum kernels This is a bit messy, but implements a variadic scalar maximum/minimum kernel. Closes #10390 from lidavidm/arrow-12751 Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: Benjamin Kietzman <bengilgit@gmail.com>
2021-06-03 21:40:29 -04:00
ARROW-9967: [Python] Add compute module docs + expose more option classes #8163 exposes `pyarrow.compute` kernels and generates their docstrings. This PR adds documentation for the module in the User Guide and the Python API reference. Closes #8145 from arw2019/ARROW-7871 Lead-authored-by: arw2019 <andrew.r.wieteska@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2020-10-08 14:57:58 +02:00
Logical Functions
ARROW-9164: [C++] Add embedded documentation to compute functions Also re-use the embedded documentations in Python to generate nicer signatures and docstrings. Closes #8457 from pitrou/ARROW-9164-compute-func-docs Authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2020-10-19 14:55:19 +02:00
-----------------
ARROW-9967: [Python] Add compute module docs + expose more option classes #8163 exposes `pyarrow.compute` kernels and generates their docstrings. This PR adds documentation for the module in the User Guide and the Python API reference. Closes #8145 from arw2019/ARROW-7871 Lead-authored-by: arw2019 <andrew.r.wieteska@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2020-10-08 14:57:58 +02:00
These functions normally emit a null when one of the inputs is null. However, Kleene
logic variants are provided (suffixed ``_kleene``). See User Guide for details.
.. autosummary::
:toctree: ../generated/
and_
and_kleene
ARROW-14012: [Python] Update kernel categories in compute doc to match C++ Update lists of compute kernels in Python and C++ documentation. Closes #11237 from edponce/ARROW-14012-Update-kernel-categories-in-compute-doc- Authored-by: Eduardo Ponce <edponce00@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-27 18:29:09 +02:00
and_not
and_not_kleene
ARROW-9967: [Python] Add compute module docs + expose more option classes #8163 exposes `pyarrow.compute` kernels and generates their docstrings. This PR adds documentation for the module in the User Guide and the Python API reference. Closes #8145 from arw2019/ARROW-7871 Lead-authored-by: arw2019 <andrew.r.wieteska@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2020-10-08 14:57:58 +02:00
invert
or_
or_kleene
xor
String Predicates
-----------------
ARROW-12949: [C++] Add starts_with and ends_with This adds a simple starts_with and ends_with. Also, now match_like can optimize some patterns into prefix/suffix matches. This also fixes a bug (which I believe is also present in Apache Impala) where some LIKE patterns are mistakenly optimized into suffix or substring matches. Closes #10448 from lidavidm/arrow-12949 Lead-authored-by: David Li <li.davidm96@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-06-08 12:37:56 +02:00
In these functions an empty string emits false in the output. For ASCII
ARROW-9967: [Python] Add compute module docs + expose more option classes #8163 exposes `pyarrow.compute` kernels and generates their docstrings. This PR adds documentation for the module in the User Guide and the Python API reference. Closes #8145 from arw2019/ARROW-7871 Lead-authored-by: arw2019 <andrew.r.wieteska@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2020-10-08 14:57:58 +02:00
variants (prefixed ``ascii_``) a string element with non-ASCII characters
emits false in the output.
ARROW-12949: [C++] Add starts_with and ends_with This adds a simple starts_with and ends_with. Also, now match_like can optimize some patterns into prefix/suffix matches. This also fixes a bug (which I believe is also present in Apache Impala) where some LIKE patterns are mistakenly optimized into suffix or substring matches. Closes #10448 from lidavidm/arrow-12949 Lead-authored-by: David Li <li.davidm96@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-06-08 12:37:56 +02:00
The first set of functions emit true if the input contains only
ARROW-9967: [Python] Add compute module docs + expose more option classes #8163 exposes `pyarrow.compute` kernels and generates their docstrings. This PR adds documentation for the module in the User Guide and the Python API reference. Closes #8145 from arw2019/ARROW-7871 Lead-authored-by: arw2019 <andrew.r.wieteska@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2020-10-08 14:57:58 +02:00
characters of a given class.
.. autosummary::
:toctree: ../generated/
ascii_is_alnum
ascii_is_alpha
ascii_is_decimal
ascii_is_lower
ascii_is_printable
ascii_is_space
ascii_is_upper
utf8_is_alnum
utf8_is_alpha
utf8_is_decimal
utf8_is_digit
utf8_is_lower
utf8_is_numeric
utf8_is_printable
utf8_is_space
utf8_is_upper
The second set of functions also consider the order of characters
in the string element.
.. autosummary::
:toctree: ../generated/
ascii_is_title
utf8_is_title
ARROW-12949: [C++] Add starts_with and ends_with This adds a simple starts_with and ends_with. Also, now match_like can optimize some patterns into prefix/suffix matches. This also fixes a bug (which I believe is also present in Apache Impala) where some LIKE patterns are mistakenly optimized into suffix or substring matches. Closes #10448 from lidavidm/arrow-12949 Lead-authored-by: David Li <li.davidm96@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-06-08 12:37:56 +02:00
The third set of functions examines string elements on
ARROW-9967: [Python] Add compute module docs + expose more option classes #8163 exposes `pyarrow.compute` kernels and generates their docstrings. This PR adds documentation for the module in the User Guide and the Python API reference. Closes #8145 from arw2019/ARROW-7871 Lead-authored-by: arw2019 <andrew.r.wieteska@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2020-10-08 14:57:58 +02:00
a byte-by-byte basis.
.. autosummary::
:toctree: ../generated/
string_is_ascii
ARROW-14012: [Python] Update kernel categories in compute doc to match C++ Update lists of compute kernels in Python and C++ documentation. Closes #11237 from edponce/ARROW-14012-Update-kernel-categories-in-compute-doc- Authored-by: Eduardo Ponce <edponce00@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-27 18:29:09 +02:00
String Transforms
-----------------
.. autosummary::
:toctree: ../generated/
ascii_capitalize
ascii_lower
ascii_reverse
ascii_swapcase
ascii_title
ascii_upper
binary_length
ARROW-12712: [C++] String repeat kernel This PR adds the string repeat compute function named "string_repeat". String repeat is a binary function that accepts Binary/StringType(s) and the repetition value(s). Repetition values can be: * a single value applied to all strings * an array of values where each repeat count corresponds to the string in the same position To support inputs of different shapes for this kernel, kernel exec generators and base classes for binary string transforms are also included. Closes #11023 from edponce/ARROW-12712-String-repeat-kernel Authored-by: Eduardo Ponce <edponce00@gmail.com> Signed-off-by: David Li <li.davidm96@gmail.com>
2021-11-04 10:43:21 -04:00
binary_repeat
ARROW-14012: [Python] Update kernel categories in compute doc to match C++ Update lists of compute kernels in Python and C++ documentation. Closes #11237 from edponce/ARROW-14012-Update-kernel-categories-in-compute-doc- Authored-by: Eduardo Ponce <edponce00@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-27 18:29:09 +02:00
binary_replace_slice
ARROW-14306: [C++][Compute] Add binary reverse kernel Closes #11883 from johanpel/ARROW-14306 Lead-authored-by: Johan Peltenburg <johan.peltenburg+code@gmail.com> Co-authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: David Li <li.davidm96@gmail.com>
2021-12-10 09:36:56 -05:00
binary_reverse
ARROW-14012: [Python] Update kernel categories in compute doc to match C++ Update lists of compute kernels in Python and C++ documentation. Closes #11237 from edponce/ARROW-14012-Update-kernel-categories-in-compute-doc- Authored-by: Eduardo Ponce <edponce00@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-27 18:29:09 +02:00
replace_substring
replace_substring_regex
utf8_capitalize
utf8_length
utf8_lower
GH-48095: [Python][Docs] Add missing {pyarrow,compute} functions to API docs (#48117) Issue #48095 and #45322 ### Rationale for this change Missing API doc entries. ### What changes are included in this PR? I've added strings for functions and options to the API doc page. ### Are these changes tested? I've built docs locally. ### Are there any user-facing changes? Docs only. * GitHub Issue: #48095 * Also covers: #45322 Lead-authored-by: Tadeja Kadunc <tadeja.kadunc@gmail.com> Co-authored-by: tadeja <tadeja@users.noreply.github.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Signed-off-by: AlenkaF <frim.alenka@gmail.com>
2025-11-20 12:35:31 +01:00
utf8_normalize
ARROW-14012: [Python] Update kernel categories in compute doc to match C++ Update lists of compute kernels in Python and C++ documentation. Closes #11237 from edponce/ARROW-14012-Update-kernel-categories-in-compute-doc- Authored-by: Eduardo Ponce <edponce00@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-27 18:29:09 +02:00
utf8_replace_slice
utf8_reverse
utf8_swapcase
utf8_title
utf8_upper
String Padding
--------------
.. autosummary::
:toctree: ../generated/
ascii_center
ascii_lpad
ascii_rpad
utf8_center
utf8_lpad
utf8_rpad
GH-46683: [C++][Python] Add utf8_zero_fill compute function for sign-aware zero padding (#46815) ### What does this PR do? Adds a new compute kernel `utf8_zero_fill` to Arrow Compute module. This kernel zero-pads UTF-8 strings while preserving leading signs. ### Why is it needed? Python's `str.zfill()` behavior is useful and expected in many data cleaning scenarios. Arrow lacked a direct equivalent. ### Implementation details - Introduces `Utf8ZeroFillTransform` with dedicated `ZeroFillOptions` - Registers `utf8_zero_fill` as a compute kernel - Adds Python bindings and a clean alias: `utf8_zfill = utf8_zero_fill` - Includes sign-aware padding logic ### Are these changes tested? - C++ unit tests: `TestStringKernels, Utf8ZeroFill` - Python tests: `test_utf8_zfill()` Ran both tests * GitHub Issue: #46683 Authored-by: iabhi4 <iamonecool@gmail.com> Signed-off-by: Antoine Pitrou <pitrou@free.fr>
2025-07-01 01:34:30 -07:00
utf8_zero_fill
ARROW-14012: [Python] Update kernel categories in compute doc to match C++ Update lists of compute kernels in Python and C++ documentation. Closes #11237 from edponce/ARROW-14012-Update-kernel-categories-in-compute-doc- Authored-by: Eduardo Ponce <edponce00@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-27 18:29:09 +02:00
String Trimming
---------------
.. autosummary::
:toctree: ../generated/
ascii_ltrim
ascii_ltrim_whitespace
ascii_rtrim
ascii_rtrim_whitespace
ascii_trim
ascii_trim_whitespace
utf8_ltrim
utf8_ltrim_whitespace
utf8_rtrim
utf8_rtrim_whitespace
utf8_trim
utf8_trim_whitespace
ARROW-12608: [C++][Python][R] Add split_pattern_regex kernel This adds a split_pattern_regex kernel using RE2. Caveats: - RE2 requires us to wrap the user's regex in a capture group in order to actually get the matched delimiter. - Reverse splitting is not implemented - there's not a good way to do this with RE2. - In R, strsplit behaves differently - trailing empty splits are no longer dropped: ``` > df <- tibble(x = c("foo bar")) > (df %>% mutate(x = strsplit(x, "bar")) %>% collect())$x [[1]] [1] "foo " > (record_batch(df) %>% mutate(x = strsplit(x, "bar")) %>% collect())$x <list<character>[1]> [[1]] [1] "foo " "" ``` So the behavior here does not exactly match R. Though this was already the case: ``` > (df %>% mutate(x = strsplit(x, "bar", fixed = TRUE)) %>% collect())$x [[1]] [1] "foo " > (record_batch(df) %>% mutate(x = strsplit(x, "bar", fixed = TRUE)) %>% collect())$x <list<character>[1]> [[1]] [1] "foo " "" ``` Closes #10354 from lidavidm/arrow-12608 Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: David Li <li.davidm96@gmail.com>
2021-05-21 08:52:47 -04:00
String Splitting
----------------
.. autosummary::
:toctree: ../generated/
ARROW-14012: [Python] Update kernel categories in compute doc to match C++ Update lists of compute kernels in Python and C++ documentation. Closes #11237 from edponce/ARROW-14012-Update-kernel-categories-in-compute-doc- Authored-by: Eduardo Ponce <edponce00@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-27 18:29:09 +02:00
ascii_split_whitespace
ARROW-12608: [C++][Python][R] Add split_pattern_regex kernel This adds a split_pattern_regex kernel using RE2. Caveats: - RE2 requires us to wrap the user's regex in a capture group in order to actually get the matched delimiter. - Reverse splitting is not implemented - there's not a good way to do this with RE2. - In R, strsplit behaves differently - trailing empty splits are no longer dropped: ``` > df <- tibble(x = c("foo bar")) > (df %>% mutate(x = strsplit(x, "bar")) %>% collect())$x [[1]] [1] "foo " > (record_batch(df) %>% mutate(x = strsplit(x, "bar")) %>% collect())$x <list<character>[1]> [[1]] [1] "foo " "" ``` So the behavior here does not exactly match R. Though this was already the case: ``` > (df %>% mutate(x = strsplit(x, "bar", fixed = TRUE)) %>% collect())$x [[1]] [1] "foo " > (record_batch(df) %>% mutate(x = strsplit(x, "bar", fixed = TRUE)) %>% collect())$x <list<character>[1]> [[1]] [1] "foo " "" ``` Closes #10354 from lidavidm/arrow-12608 Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: David Li <li.davidm96@gmail.com>
2021-05-21 08:52:47 -04:00
split_pattern
split_pattern_regex
utf8_split_whitespace
ARROW-12709: [C++] Add binary_join_element_wise This adds a variadic scalar string join kernel, using the last argument (min 1 argument) as the separator. An options class allows emitting null (the default), skipping null non-separator arguments, or replacing null non-separator arguments with another string (mimicking libcudf). Closes #10520 from lidavidm/arrow-12709 Lead-authored-by: David Li <li.davidm96@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-06-16 20:19:27 +02:00
String Component Extraction
---------------------------
.. autosummary::
:toctree: ../generated/
extract_regex
GH-48095: [Python][Docs] Add missing {pyarrow,compute} functions to API docs (#48117) Issue #48095 and #45322 ### Rationale for this change Missing API doc entries. ### What changes are included in this PR? I've added strings for functions and options to the API doc page. ### Are these changes tested? I've built docs locally. ### Are there any user-facing changes? Docs only. * GitHub Issue: #48095 * Also covers: #45322 Lead-authored-by: Tadeja Kadunc <tadeja.kadunc@gmail.com> Co-authored-by: tadeja <tadeja@users.noreply.github.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Signed-off-by: AlenkaF <frim.alenka@gmail.com>
2025-11-20 12:35:31 +01:00
extract_regex_span
ARROW-12709: [C++] Add binary_join_element_wise This adds a variadic scalar string join kernel, using the last argument (min 1 argument) as the separator. An options class allows emitting null (the default), skipping null non-separator arguments, or replacing null non-separator arguments with another string (mimicking libcudf). Closes #10520 from lidavidm/arrow-12709 Lead-authored-by: David Li <li.davidm96@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-06-16 20:19:27 +02:00
String Joining
--------------
.. autosummary::
:toctree: ../generated/
binary_join
binary_join_element_wise
ARROW-14012: [Python] Update kernel categories in compute doc to match C++ Update lists of compute kernels in Python and C++ documentation. Closes #11237 from edponce/ARROW-14012-Update-kernel-categories-in-compute-doc- Authored-by: Eduardo Ponce <edponce00@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-27 18:29:09 +02:00
String Slicing
--------------
ARROW-9967: [Python] Add compute module docs + expose more option classes #8163 exposes `pyarrow.compute` kernels and generates their docstrings. This PR adds documentation for the module in the User Guide and the Python API reference. Closes #8145 from arw2019/ARROW-7871 Lead-authored-by: arw2019 <andrew.r.wieteska@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2020-10-08 14:57:58 +02:00
.. autosummary::
:toctree: ../generated/
ARROW-17301: [C++] Implement compute function "binary_slice" (#14550) Implements `binary_slice_bytes` similar to `utf8_slice_codeunits`. Mostly based on `utf8_slice_codeunits`. TODO: * [x] C++ Tests * [x] Python Tests Authored-by: kshitij12345 <kshitijkalambarkar@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2022-11-15 16:57:24 +05:30
binary_slice
MINOR: [Docs] Fix names of compute functions in python/cpp docs Small follow-up on https://github.com/apache/arrow/pull/11237 Closes #11288 from jorisvandenbossche/minor-compute-names Authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com> Signed-off-by: David Li <li.davidm96@gmail.com>
2021-10-01 09:59:44 -04:00
utf8_slice_codeunits
ARROW-9967: [Python] Add compute module docs + expose more option classes #8163 exposes `pyarrow.compute` kernels and generates their docstrings. This PR adds documentation for the module in the User Guide and the Python API reference. Closes #8145 from arw2019/ARROW-7871 Lead-authored-by: arw2019 <andrew.r.wieteska@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2020-10-08 14:57:58 +02:00
ARROW-14012: [Python] Update kernel categories in compute doc to match C++ Update lists of compute kernels in Python and C++ documentation. Closes #11237 from edponce/ARROW-14012-Update-kernel-categories-in-compute-doc- Authored-by: Eduardo Ponce <edponce00@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-27 18:29:09 +02:00
Containment Tests
ARROW-9967: [Python] Add compute module docs + expose more option classes #8163 exposes `pyarrow.compute` kernels and generates their docstrings. This PR adds documentation for the module in the User Guide and the Python API reference. Closes #8145 from arw2019/ARROW-7871 Lead-authored-by: arw2019 <andrew.r.wieteska@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2020-10-08 14:57:58 +02:00
-----------------
.. autosummary::
:toctree: ../generated/
ARROW-12950: [C++] Add count_substring kernel Depends on ARROW-12969. ignore_case is not included here; I'll include it with the regex variant in ARROW-12952. Closes #10454 from lidavidm/arrow-12950 Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-06-07 20:45:36 +02:00
count_substring
ARROW-12952: [C++] Add count_substring_regex This also adds the regular case-insensitive count_substring. Closes #10471 from lidavidm/arrow-12952 Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: David Li <li.davidm96@gmail.com>
2021-06-10 16:02:22 -04:00
count_substring_regex
ARROW-12949: [C++] Add starts_with and ends_with This adds a simple starts_with and ends_with. Also, now match_like can optimize some patterns into prefix/suffix matches. This also fixes a bug (which I believe is also present in Apache Impala) where some LIKE patterns are mistakenly optimized into suffix or substring matches. Closes #10448 from lidavidm/arrow-12949 Lead-authored-by: David Li <li.davidm96@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-06-08 12:37:56 +02:00
ends_with
ARROW-12717: [C++][Python] Add find_substring kernel This adds a very simple lfind kernel. If the substring is not found, -1 is reported. Nulls are propagated. Regexes are not supported, nor is rfind. Closes #10353 from lidavidm/arrow-12717 Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: Yibo Cai <yibo.cai@arm.com>
2021-05-22 15:19:39 +08:00
find_substring
ARROW-13157: [C++][Python] Add find_substring_regex kernel and implement ignore_case for find_substring This adds a `find_substring_regex` kernel and adds support for case insensitivity to the `find_substring` kernel. RE2 only returns the match position if you have a capture group. Hence we have to modify the supplied regex. For literal patterns, we have to use RE2::QuoteMeta instead of setting the literal flag on the regex. Closes #10597 from lidavidm/arrow-13157 Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-06-28 16:15:59 +02:00
find_substring_regex
ARROW-9967: [Python] Add compute module docs + expose more option classes #8163 exposes `pyarrow.compute` kernels and generates their docstrings. This PR adds documentation for the module in the User Guide and the Python API reference. Closes #8145 from arw2019/ARROW-7871 Lead-authored-by: arw2019 <andrew.r.wieteska@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2020-10-08 14:57:58 +02:00
index_in
is_in
ARROW-12715: [C++][Python] Add SQL LIKE match kernel Implements a simple SQL LIKE pattern match kernel by translating it to a regex (or substring) match as appropriate. Closes #10356 from lidavidm/arrow-12715 Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: David Li <li.davidm96@gmail.com>
2021-05-20 10:44:09 -04:00
match_like
ARROW-9967: [Python] Add compute module docs + expose more option classes #8163 exposes `pyarrow.compute` kernels and generates their docstrings. This PR adds documentation for the module in the User Guide and the Python API reference. Closes #8145 from arw2019/ARROW-7871 Lead-authored-by: arw2019 <andrew.r.wieteska@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2020-10-08 14:57:58 +02:00
match_substring
ARROW-12134: [C++] Add match_substring_regex kernel For consistency with match_substring, this is the equivalent of Python's re.search(), not re.match(). Closes #9838 from lidavidm/arrow-12134 Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-04-06 17:30:38 +02:00
match_substring_regex
ARROW-12949: [C++] Add starts_with and ends_with This adds a simple starts_with and ends_with. Also, now match_like can optimize some patterns into prefix/suffix matches. This also fixes a bug (which I believe is also present in Apache Impala) where some LIKE patterns are mistakenly optimized into suffix or substring matches. Closes #10448 from lidavidm/arrow-12949 Lead-authored-by: David Li <li.davidm96@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-06-08 12:37:56 +02:00
starts_with
ARROW-13035: [C++] indices_nonzero compute function Add a `indices_nonzero` compute function that returns the indices of an array that contain values `!= 0` or `!= false`. This can be used in conjunction with our existing functions that return a mask to get back the indices where the mask matches. Closes #11886 from amol-/ARROW-13035 Authored-by: Alessandro Molina <amol@turbogears.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2022-01-04 20:42:28 +01:00
indices_nonzero
ARROW-9967: [Python] Add compute module docs + expose more option classes #8163 exposes `pyarrow.compute` kernels and generates their docstrings. This PR adds documentation for the module in the User Guide and the Python API reference. Closes #8145 from arw2019/ARROW-7871 Lead-authored-by: arw2019 <andrew.r.wieteska@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2020-10-08 14:57:58 +02:00
ARROW-14012: [Python] Update kernel categories in compute doc to match C++ Update lists of compute kernels in Python and C++ documentation. Closes #11237 from edponce/ARROW-14012-Update-kernel-categories-in-compute-doc- Authored-by: Eduardo Ponce <edponce00@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-27 18:29:09 +02:00
Categorizations
---------------
.. autosummary::
:toctree: ../generated/
is_finite
is_inf
is_nan
is_null
is_valid
ARROW-12659: [C++] Support is_valid as a guarantee This rebases #10253 and fixes it up to also address ARROW-15312, including a regression test. This refactors how inequalities, is_valid, and is_null are treated in expression simplification, and updates the guarantees that the Parquet/Datasets emits for row groups to properly reflect nullability. Closes #12891 from lidavidm/arrow-12659 Lead-authored-by: David Li <li.davidm96@gmail.com> Co-authored-by: Benjamin Kietzman <bengilgit@gmail.com> Co-authored-by: Antoine Pitrou <pitrou@free.fr> Signed-off-by: Jonathan Keane <jkeane@gmail.com>
2022-04-21 13:55:15 -05:00
true_unless_null
ARROW-14012: [Python] Update kernel categories in compute doc to match C++ Update lists of compute kernels in Python and C++ documentation. Closes #11237 from edponce/ARROW-14012-Update-kernel-categories-in-compute-doc- Authored-by: Eduardo Ponce <edponce00@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-27 18:29:09 +02:00
Selecting / Multiplexing
------------------------
.. autosummary::
:toctree: ../generated/
case_when
choose
coalesce
if_else
ARROW-9967: [Python] Add compute module docs + expose more option classes #8163 exposes `pyarrow.compute` kernels and generates their docstrings. This PR adds documentation for the module in the User Guide and the Python API reference. Closes #8145 from arw2019/ARROW-7871 Lead-authored-by: arw2019 <andrew.r.wieteska@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2020-10-08 14:57:58 +02:00
Conversions
-----------
.. autosummary::
:toctree: ../generated/
cast
ARROW-14822: [C++] Implement floor/ceil/round for temporal objects This is to resolve [ARROW-14822](https://issues.apache.org/jira/browse/ARROW-14822). Closes #11818 from rok/ARROW-14822 Authored-by: Rok <rok@mihevc.org> Signed-off-by: David Li <li.davidm96@gmail.com>
2022-01-04 16:31:01 -05:00
ceil_temporal
floor_temporal
round_temporal
GH-34568: [C++][Python] Expose Run-End Encoded arrays in Python Arrow (#34570) * Closes: #34568 Authored-by: Felipe Oliveira Carvalho <felipekde@gmail.com> Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
2023-03-23 05:20:06 -03:00
run_end_decode
run_end_encode
ARROW-14012: [Python] Update kernel categories in compute doc to match C++ Update lists of compute kernels in Python and C++ documentation. Closes #11237 from edponce/ARROW-14012-Update-kernel-categories-in-compute-doc- Authored-by: Eduardo Ponce <edponce00@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-27 18:29:09 +02:00
strftime
ARROW-9967: [Python] Add compute module docs + expose more option classes #8163 exposes `pyarrow.compute` kernels and generates their docstrings. This PR adds documentation for the module in the User Guide and the Python API reference. Closes #8145 from arw2019/ARROW-7871 Lead-authored-by: arw2019 <andrew.r.wieteska@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2020-10-08 14:57:58 +02:00
strptime
ARROW-14012: [Python] Update kernel categories in compute doc to match C++ Update lists of compute kernels in Python and C++ documentation. Closes #11237 from edponce/ARROW-14012-Update-kernel-categories-in-compute-doc- Authored-by: Eduardo Ponce <edponce00@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-27 18:29:09 +02:00
Temporal Component Extraction
ARROW-13549: [C++] Add casts from timestamp to date/time Closes #10933 from lidavidm/arrow-13549 Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-27 16:44:26 +02:00
-----------------------------
.. autosummary::
:toctree: ../generated/
day
day_of_week
day_of_year
hour
GH-48095: [Python][Docs] Add missing {pyarrow,compute} functions to API docs (#48117) Issue #48095 and #45322 ### Rationale for this change Missing API doc entries. ### What changes are included in this PR? I've added strings for functions and options to the API doc page. ### Are these changes tested? I've built docs locally. ### Are there any user-facing changes? Docs only. * GitHub Issue: #48095 * Also covers: #45322 Lead-authored-by: Tadeja Kadunc <tadeja.kadunc@gmail.com> Co-authored-by: tadeja <tadeja@users.noreply.github.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Signed-off-by: AlenkaF <frim.alenka@gmail.com>
2025-11-20 12:35:31 +01:00
is_dst
is_leap_year
ARROW-13549: [C++] Add casts from timestamp to date/time Closes #10933 from lidavidm/arrow-13549 Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-27 16:44:26 +02:00
iso_week
iso_year
ARROW-14012: [Python] Update kernel categories in compute doc to match C++ Update lists of compute kernels in Python and C++ documentation. Closes #11237 from edponce/ARROW-14012-Update-kernel-categories-in-compute-doc- Authored-by: Eduardo Ponce <edponce00@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-27 18:29:09 +02:00
iso_calendar
ARROW-13549: [C++] Add casts from timestamp to date/time Closes #10933 from lidavidm/arrow-13549 Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-27 16:44:26 +02:00
microsecond
millisecond
minute
month
nanosecond
quarter
second
subsecond
ARROW-14012: [Python] Update kernel categories in compute doc to match C++ Update lists of compute kernels in Python and C++ documentation. Closes #11237 from edponce/ARROW-14012-Update-kernel-categories-in-compute-doc- Authored-by: Eduardo Ponce <edponce00@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-27 18:29:09 +02:00
us_week
ARROW-14825: [C++] Temporal component extraction function for extracting epiyear This is to resolve [ARROW-14825](https://issues.apache.org/jira/browse/ARROW-14825). Closes #12372 from rok/ARROW-14825 Authored-by: Rok <rok@mihevc.org> Signed-off-by: David Li <li.davidm96@gmail.com>
2022-02-10 15:47:24 -05:00
us_year
ARROW-14012: [Python] Update kernel categories in compute doc to match C++ Update lists of compute kernels in Python and C++ documentation. Closes #11237 from edponce/ARROW-14012-Update-kernel-categories-in-compute-doc- Authored-by: Eduardo Ponce <edponce00@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-27 18:29:09 +02:00
week
ARROW-13549: [C++] Add casts from timestamp to date/time Closes #10933 from lidavidm/arrow-13549 Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-27 16:44:26 +02:00
year
ARROW-15032: [C++] Add year_month_day function Adds a year_month_day function for temporal inputs Closes #11990 from WillAyd/add-ymd-func Lead-authored-by: William Ayd <william.ayd@icloud.com> Co-authored-by: William Ayd <will_ayd@innobi.io> Signed-off-by: David Li <li.davidm96@gmail.com>
2022-01-04 20:35:24 -05:00
year_month_day
ARROW-13549: [C++] Add casts from timestamp to date/time Closes #10933 from lidavidm/arrow-13549 Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-27 16:44:26 +02:00
ARROW-13548: [C++] Implement temporal difference kernels Implements kernels to get the number of {years, months, days and millis, days, hours, minutes, seconds, millis, micros, nanos} between two timestamps. Everything returns either Int64 or DayTimeInterval. Closes #10960 from lidavidm/arrow-13548 Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-29 09:50:37 +02:00
Temporal Difference
-------------------
.. autosummary::
:toctree: ../generated/
day_time_interval_between
days_between
hours_between
microseconds_between
milliseconds_between
minutes_between
month_day_nano_interval_between
month_interval_between
nanoseconds_between
quarters_between
seconds_between
weeks_between
years_between
ARROW-14012: [Python] Update kernel categories in compute doc to match C++ Update lists of compute kernels in Python and C++ documentation. Closes #11237 from edponce/ARROW-14012-Update-kernel-categories-in-compute-doc- Authored-by: Eduardo Ponce <edponce00@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-27 18:29:09 +02:00
Timezone Handling
-----------------
ARROW-9430: [C++] Implement replace_with_mask kernel This implements a kernel equivalent to NumPy's `arr[mask] = [values]`, i.e. given an array and an equal-length (or scalar) boolean mask, along with an array of replacement values passed via options, each array item for which the corresponding mask value is `true` is replaced with the next value from the replacement value array. Closes #10412 from lidavidm/arrow-9430 Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: David Li <li.davidm96@gmail.com>
2021-07-14 11:42:00 -04:00
.. autosummary::
:toctree: ../generated/
ARROW-14012: [Python] Update kernel categories in compute doc to match C++ Update lists of compute kernels in Python and C++ documentation. Closes #11237 from edponce/ARROW-14012-Update-kernel-categories-in-compute-doc- Authored-by: Eduardo Ponce <edponce00@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-27 18:29:09 +02:00
assume_timezone
MINOR: [Docs] local_timestamp kernel docs are not linked in python docs (#39274) ### Rationale for this change local_timestamp kernel docs are linked in [cpp](https://arrow.apache.org/docs/cpp/compute.html#timezone-handling) but not in [python docs](https://arrow.apache.org/docs/python/api/compute.html#timezone-handling). ### What changes are included in this PR? This adds a rst link in python docs ### Are these changes tested? No ### Are there any user-facing changes? Change will be visible in the docs Authored-by: Rok Mihevc <rok@mihevc.org> Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
2023-12-20 11:06:57 +01:00
local_timestamp
ARROW-9430: [C++] Implement replace_with_mask kernel This implements a kernel equivalent to NumPy's `arr[mask] = [values]`, i.e. given an array and an equal-length (or scalar) boolean mask, along with an array of replacement values passed via options, each array item for which the corresponding mask value is `true` is replaced with the next value from the replacement value array. Closes #10412 from lidavidm/arrow-9430 Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: David Li <li.davidm96@gmail.com>
2021-07-14 11:42:00 -04:00
GH-48095: [Python][Docs] Add missing {pyarrow,compute} functions to API docs (#48117) Issue #48095 and #45322 ### Rationale for this change Missing API doc entries. ### What changes are included in this PR? I've added strings for functions and options to the API doc page. ### Are these changes tested? I've built docs locally. ### Are there any user-facing changes? Docs only. * GitHub Issue: #48095 * Also covers: #45322 Lead-authored-by: Tadeja Kadunc <tadeja.kadunc@gmail.com> Co-authored-by: tadeja <tadeja@users.noreply.github.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Signed-off-by: AlenkaF <frim.alenka@gmail.com>
2025-11-20 12:35:31 +01:00
Random Number Generation
------------------------
.. autosummary::
:toctree: ../generated/
random
ARROW-14012: [Python] Update kernel categories in compute doc to match C++ Update lists of compute kernels in Python and C++ documentation. Closes #11237 from edponce/ARROW-14012-Update-kernel-categories-in-compute-doc- Authored-by: Eduardo Ponce <edponce00@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-27 18:29:09 +02:00
Associative Transforms
----------------------
ARROW-9967: [Python] Add compute module docs + expose more option classes #8163 exposes `pyarrow.compute` kernels and generates their docstrings. This PR adds documentation for the module in the User Guide and the Python API reference. Closes #8145 from arw2019/ARROW-7871 Lead-authored-by: arw2019 <andrew.r.wieteska@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2020-10-08 14:57:58 +02:00
.. autosummary::
:toctree: ../generated/
GH-48095: [Python][Docs] Add missing {pyarrow,compute} functions to API docs (#48117) Issue #48095 and #45322 ### Rationale for this change Missing API doc entries. ### What changes are included in this PR? I've added strings for functions and options to the API doc page. ### Are these changes tested? I've built docs locally. ### Are there any user-facing changes? Docs only. * GitHub Issue: #48095 * Also covers: #45322 Lead-authored-by: Tadeja Kadunc <tadeja.kadunc@gmail.com> Co-authored-by: tadeja <tadeja@users.noreply.github.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Signed-off-by: AlenkaF <frim.alenka@gmail.com>
2025-11-20 12:35:31 +01:00
dictionary_decode
ARROW-14012: [Python] Update kernel categories in compute doc to match C++ Update lists of compute kernels in Python and C++ documentation. Closes #11237 from edponce/ARROW-14012-Update-kernel-categories-in-compute-doc- Authored-by: Eduardo Ponce <edponce00@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-27 18:29:09 +02:00
dictionary_encode
unique
value_counts
ARROW-9967: [Python] Add compute module docs + expose more option classes #8163 exposes `pyarrow.compute` kernels and generates their docstrings. This PR adds documentation for the module in the User Guide and the Python API reference. Closes #8145 from arw2019/ARROW-7871 Lead-authored-by: arw2019 <andrew.r.wieteska@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2020-10-08 14:57:58 +02:00
ARROW-14012: [Python] Update kernel categories in compute doc to match C++ Update lists of compute kernels in Python and C++ documentation. Closes #11237 from edponce/ARROW-14012-Update-kernel-categories-in-compute-doc- Authored-by: Eduardo Ponce <edponce00@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-27 18:29:09 +02:00
Selections
----------
ARROW-9967: [Python] Add compute module docs + expose more option classes #8163 exposes `pyarrow.compute` kernels and generates their docstrings. This PR adds documentation for the module in the User Guide and the Python API reference. Closes #8145 from arw2019/ARROW-7871 Lead-authored-by: arw2019 <andrew.r.wieteska@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2020-10-08 14:57:58 +02:00
.. autosummary::
:toctree: ../generated/
ARROW-14012: [Python] Update kernel categories in compute doc to match C++ Update lists of compute kernels in Python and C++ documentation. Closes #11237 from edponce/ARROW-14012-Update-kernel-categories-in-compute-doc- Authored-by: Eduardo Ponce <edponce00@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-27 18:29:09 +02:00
array_filter
array_take
drop_null
filter
GH-48095: [Python][Docs] Add missing {pyarrow,compute} functions to API docs (#48117) Issue #48095 and #45322 ### Rationale for this change Missing API doc entries. ### What changes are included in this PR? I've added strings for functions and options to the API doc page. ### Are these changes tested? I've built docs locally. ### Are there any user-facing changes? Docs only. * GitHub Issue: #48095 * Also covers: #45322 Lead-authored-by: Tadeja Kadunc <tadeja.kadunc@gmail.com> Co-authored-by: tadeja <tadeja@users.noreply.github.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Signed-off-by: AlenkaF <frim.alenka@gmail.com>
2025-11-20 12:35:31 +01:00
inverse_permutation
scatter
GH-48167: [Python][C++][Compute] Add python bindings for scatter, inverse_permutation (#48267) ### Rationale for this change To close or discuss #48167 `inverse_permutation` and `scatter` functions got implemented via #44393, PR #44394. ### What changes are included in this PR? Python tests for `scatter`, `inverse_permutation` kernels and bindings for `InversePermutationOptions` and `ScatterOptions`. ### Are these changes tested? Yes, tests added in test_compute.py. ### Are there any user-facing changes? Bindings for `InversePermutationOptions` and `ScatterOptions` are added. #### This PR includes breaking changes to public APIs. Options `InversePermutationOptions` changed from accepting parameter `std::shared_ptr<DataType> output_type = NULLPTR` to `std::optional<std::shared_ptr<DataType>> output_type = std::nullopt` * GitHub Issue: #48167 Lead-authored-by: Tadeja Kadunc <tadeja.kadunc@gmail.com> Co-authored-by: Rossi Sun <zanmato1984@gmail.com> Co-authored-by: tadeja <tadeja@users.noreply.github.com> Signed-off-by: Rossi Sun <zanmato1984@gmail.com>
2025-12-29 08:14:36 +01:00
take
ARROW-9967: [Python] Add compute module docs + expose more option classes #8163 exposes `pyarrow.compute` kernels and generates their docstrings. This PR adds documentation for the module in the User Guide and the Python API reference. Closes #8145 from arw2019/ARROW-7871 Lead-authored-by: arw2019 <andrew.r.wieteska@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2020-10-08 14:57:58 +02:00
ARROW-14012: [Python] Update kernel categories in compute doc to match C++ Update lists of compute kernels in Python and C++ documentation. Closes #11237 from edponce/ARROW-14012-Update-kernel-categories-in-compute-doc- Authored-by: Eduardo Ponce <edponce00@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-27 18:29:09 +02:00
Sorts and Partitions
ARROW-9967: [Python] Add compute module docs + expose more option classes #8163 exposes `pyarrow.compute` kernels and generates their docstrings. This PR adds documentation for the module in the User Guide and the Python API reference. Closes #8145 from arw2019/ARROW-7871 Lead-authored-by: arw2019 <andrew.r.wieteska@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2020-10-08 14:57:58 +02:00
--------------------
.. autosummary::
:toctree: ../generated/
ARROW-14012: [Python] Update kernel categories in compute doc to match C++ Update lists of compute kernels in Python and C++ documentation. Closes #11237 from edponce/ARROW-14012-Update-kernel-categories-in-compute-doc- Authored-by: Eduardo Ponce <edponce00@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-27 18:29:09 +02:00
array_sort_indices
GH-48095: [Python][Docs] Add missing {pyarrow,compute} functions to API docs (#48117) Issue #48095 and #45322 ### Rationale for this change Missing API doc entries. ### What changes are included in this PR? I've added strings for functions and options to the API doc page. ### Are these changes tested? I've built docs locally. ### Are there any user-facing changes? Docs only. * GitHub Issue: #48095 * Also covers: #45322 Lead-authored-by: Tadeja Kadunc <tadeja.kadunc@gmail.com> Co-authored-by: tadeja <tadeja@users.noreply.github.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Signed-off-by: AlenkaF <frim.alenka@gmail.com>
2025-11-20 12:35:31 +01:00
bottom_k_unstable
ARROW-9967: [Python] Add compute module docs + expose more option classes #8163 exposes `pyarrow.compute` kernels and generates their docstrings. This PR adds documentation for the module in the User Guide and the Python API reference. Closes #8145 from arw2019/ARROW-7871 Lead-authored-by: arw2019 <andrew.r.wieteska@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2020-10-08 14:57:58 +02:00
partition_nth_indices
GH-48095: [Python][Docs] Add missing {pyarrow,compute} functions to API docs (#48117) Issue #48095 and #45322 ### Rationale for this change Missing API doc entries. ### What changes are included in this PR? I've added strings for functions and options to the API doc page. ### Are these changes tested? I've built docs locally. ### Are there any user-facing changes? Docs only. * GitHub Issue: #48095 * Also covers: #45322 Lead-authored-by: Tadeja Kadunc <tadeja.kadunc@gmail.com> Co-authored-by: tadeja <tadeja@users.noreply.github.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Signed-off-by: AlenkaF <frim.alenka@gmail.com>
2025-11-20 12:35:31 +01:00
rank
rank_normal
rank_quantile
ARROW-1565: [C++] Implement TopK/BottomK Heap-based topk can compute these indices in O(n log k) time Closes #11019 from aocsa/aocsa/ARROW-1565 Authored-by: Alexander <aocsa.cs@gmail.com> Signed-off-by: David Li <li.davidm96@gmail.com>
2021-09-10 10:42:31 -04:00
select_k_unstable
ARROW-9967: [Python] Add compute module docs + expose more option classes #8163 exposes `pyarrow.compute` kernels and generates their docstrings. This PR adds documentation for the module in the User Guide and the Python API reference. Closes #8145 from arw2019/ARROW-7871 Lead-authored-by: arw2019 <andrew.r.wieteska@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2020-10-08 14:57:58 +02:00
sort_indices
GH-48095: [Python][Docs] Add missing {pyarrow,compute} functions to API docs (#48117) Issue #48095 and #45322 ### Rationale for this change Missing API doc entries. ### What changes are included in this PR? I've added strings for functions and options to the API doc page. ### Are these changes tested? I've built docs locally. ### Are there any user-facing changes? Docs only. * GitHub Issue: #48095 * Also covers: #45322 Lead-authored-by: Tadeja Kadunc <tadeja.kadunc@gmail.com> Co-authored-by: tadeja <tadeja@users.noreply.github.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Signed-off-by: AlenkaF <frim.alenka@gmail.com>
2025-11-20 12:35:31 +01:00
top_k_unstable
Statistical Functions
---------------------
.. autosummary::
:toctree: ../generated/
winsorize
ARROW-9967: [Python] Add compute module docs + expose more option classes #8163 exposes `pyarrow.compute` kernels and generates their docstrings. This PR adds documentation for the module in the User Guide and the Python API reference. Closes #8145 from arw2019/ARROW-7871 Lead-authored-by: arw2019 <andrew.r.wieteska@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2020-10-08 14:57:58 +02:00
Structural Transforms
---------------------
.. autosummary::
:toctree: ../generated/
GH-34143 [Python][Docs] Add fill_null back to API reference (#34144) ### Rationale for this change Add fill_null back to the docs -[x] closes #34143 * Closes: #34143 Authored-by: Patrick Hoefler <61934744+phofl@users.noreply.github.com> Signed-off-by: Sutou Kouhei <kou@clear-code.com>
2023-02-12 06:32:50 +01:00
fill_null
MINOR: [Docs] Add fill_null functions to docs Add the docs for the functions from ARROW-1699/PR #11853 since they were omitted in the PR. Closes #12082 from lidavidm/arrow-1699 Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: David Li <li.davidm96@gmail.com>
2022-01-05 15:48:10 -05:00
fill_null_backward
fill_null_forward
ARROW-12669:[C++][Python] Implement a new scalar function: list_element https://issues.apache.org/jira/browse/ARROW-12669 Closes #11159 from aucahuasi/return-array-for-each-list-in-array Authored-by: Percy Camilo Triveño Aucahuasi <percy.camilo.ta@gmail.com> Signed-off-by: David Li <li.davidm96@gmail.com>
2021-09-20 15:39:12 -04:00
list_element
ARROW-9967: [Python] Add compute module docs + expose more option classes #8163 exposes `pyarrow.compute` kernels and generates their docstrings. This PR adds documentation for the module in the User Guide and the Python API reference. Closes #8145 from arw2019/ARROW-7871 Lead-authored-by: arw2019 <andrew.r.wieteska@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2020-10-08 14:57:58 +02:00
list_flatten
list_parent_indices
ARROW-17960: [C++][Python] Implement list_slice kernel (#14395) Will fix [ARROW-17960](https://issues.apache.org/jira/browse/ARROW-17960) Authored-by: Miles Granger <miles59923@gmail.com> Signed-off-by: David Li <li.davidm96@gmail.com>
2022-11-15 18:56:16 +01:00
list_slice
ARROW-12669:[C++][Python] Implement a new scalar function: list_element https://issues.apache.org/jira/browse/ARROW-12669 Closes #11159 from aucahuasi/return-array-for-each-list-in-array Authored-by: Percy Camilo Triveño Aucahuasi <percy.camilo.ta@gmail.com> Signed-off-by: David Li <li.davidm96@gmail.com>
2021-09-20 15:39:12 -04:00
list_value_length
ARROW-14012: [Python] Update kernel categories in compute doc to match C++ Update lists of compute kernels in Python and C++ documentation. Closes #11237 from edponce/ARROW-14012-Update-kernel-categories-in-compute-doc- Authored-by: Eduardo Ponce <edponce00@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-27 18:29:09 +02:00
make_struct
ARROW-15089: [C++][Compute] Implement kernel to lookup a MapArray item for a given key Implement a Scalar Kernel to lookup a value for a given key in a `MapArray`, whose type is an alias for `List(Struct(<key>, <item>))` Todo: - [x] Add more tests and combinations (Do suggest more) - [x] `null` maps - [x] empty maps - [x] `null` items - [x] `null` non-empty items Types tested: - [x] PhysicalIntegralArrowTypes - [x] DecimalArrowTypes - [x] BaseBinaryArrowTypes - [x] Boolean - [x] FixedSizeString - [x] MonthDayNanoInterval - [x] Template Kernel Things to consider: - [x] Looking up `null` keys. (Null keys are not allowed) Closes #12162 from dhruv9vats/arrow-15089-test Lead-authored-by: Dhruv Vats <dhruv25vats@gmail.com> Co-authored-by: Dhruv Vats <dhruv@Dhruvs-MacBook-Pro.local> Signed-off-by: David Li <li.davidm96@gmail.com>
2022-02-03 08:38:33 -05:00
map_lookup
ARROW-14012: [Python] Update kernel categories in compute doc to match C++ Update lists of compute kernels in Python and C++ documentation. Closes #11237 from edponce/ARROW-14012-Update-kernel-categories-in-compute-doc- Authored-by: Eduardo Ponce <edponce00@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-09-27 18:29:09 +02:00
replace_with_mask
ARROW-14615: [C++] Refactor nested field refs and add union support Closes #11641 from lidavidm/arrow-14615 Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-11-10 14:27:04 +01:00
struct_field
ARROW-13832: [Doc] Improve compute documentation Document a bit better the compute functions and add a section about grouped aggregations. Also list the available aggregation functions automatically. ![sshot2](https://user-images.githubusercontent.com/601423/144261429-90ca370c-8431-424b-9f6d-44a17846c055.png) Closes #11830 from amol-/ARROW-13832 Authored-by: Alessandro Molina <amol@turbogears.org> Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
2021-12-09 13:53:34 +01:00
GH-35786: [C++] Add pairwise_diff function (#35787) ### Rationale for this change Add a `pairwise_diff` function similar to pandas' [Series.Diff](https://pandas.pydata.org/docs/reference/api/pandas.Series.diff.html), the function computes the first order difference of an array. ### What changes are included in this PR? I followed [these instructions](https://github.com/apache/arrow/pull/12460#issuecomment-1057520554). The function is implemented for numerical, temporal and decimal types. Chuck arrays are not yet supported. ### Are these changes tested? Yes. They are tested in vector_pairwise_test.cc and in python/pyarrow/tests/compute.py. ### Are there any user-facing changes? Yes, and docs are also updated in this PR. * Closes: #35786 Lead-authored-by: Jin Shang <shangjin1997@gmail.com> Co-authored-by: Benjamin Kietzman <bengilgit@gmail.com> Signed-off-by: Benjamin Kietzman <bengilgit@gmail.com>
2023-06-29 20:43:23 +08:00
Pairwise Functions
------------------
.. autosummary::
:toctree: ../generated/
pairwise_diff
GH-48095: [Python][Docs] Add missing {pyarrow,compute} functions to API docs (#48117) Issue #48095 and #45322 ### Rationale for this change Missing API doc entries. ### What changes are included in this PR? I've added strings for functions and options to the API doc page. ### Are these changes tested? I've built docs locally. ### Are there any user-facing changes? Docs only. * GitHub Issue: #48095 * Also covers: #45322 Lead-authored-by: Tadeja Kadunc <tadeja.kadunc@gmail.com> Co-authored-by: tadeja <tadeja@users.noreply.github.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Signed-off-by: AlenkaF <frim.alenka@gmail.com>
2025-11-20 12:35:31 +01:00
pairwise_diff_checked
GH-35786: [C++] Add pairwise_diff function (#35787) ### Rationale for this change Add a `pairwise_diff` function similar to pandas' [Series.Diff](https://pandas.pydata.org/docs/reference/api/pandas.Series.diff.html), the function computes the first order difference of an array. ### What changes are included in this PR? I followed [these instructions](https://github.com/apache/arrow/pull/12460#issuecomment-1057520554). The function is implemented for numerical, temporal and decimal types. Chuck arrays are not yet supported. ### Are these changes tested? Yes. They are tested in vector_pairwise_test.cc and in python/pyarrow/tests/compute.py. ### Are there any user-facing changes? Yes, and docs are also updated in this PR. * Closes: #35786 Lead-authored-by: Jin Shang <shangjin1997@gmail.com> Co-authored-by: Benjamin Kietzman <bengilgit@gmail.com> Signed-off-by: Benjamin Kietzman <bengilgit@gmail.com>
2023-06-29 20:43:23 +08:00
ARROW-13832: [Doc] Improve compute documentation Document a bit better the compute functions and add a section about grouped aggregations. Also list the available aggregation functions automatically. ![sshot2](https://user-images.githubusercontent.com/601423/144261429-90ca370c-8431-424b-9f6d-44a17846c055.png) Closes #11830 from amol-/ARROW-13832 Authored-by: Alessandro Molina <amol@turbogears.org> Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
2021-12-09 13:53:34 +01:00
Compute Options
---------------
.. autosummary::
:toctree: ../generated/
ArraySortOptions
AssumeTimezoneOptions
CastOptions
CountOptions
GH-48095: [Python][Docs] Add missing {pyarrow,compute} functions to API docs (#48117) Issue #48095 and #45322 ### Rationale for this change Missing API doc entries. ### What changes are included in this PR? I've added strings for functions and options to the API doc page. ### Are these changes tested? I've built docs locally. ### Are there any user-facing changes? Docs only. * GitHub Issue: #48095 * Also covers: #45322 Lead-authored-by: Tadeja Kadunc <tadeja.kadunc@gmail.com> Co-authored-by: tadeja <tadeja@users.noreply.github.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Signed-off-by: AlenkaF <frim.alenka@gmail.com>
2025-11-20 12:35:31 +01:00
CumulativeOptions
ARROW-13530: [C++] Implement cumulative sum compute function Creating new compute function to perform a cumulative sum on a given array/vector. Closes #12460 from JabariBooker/ARROW-13530 Lead-authored-by: JabariBooker <o.jabari.booker@gmail.com> Co-authored-by: Eduardo Ponce <edponce00@gmail.com> Co-authored-by: Jabari Booker <o.jabari.booker@gmail.com> Co-authored-by: Jabari Booker <booker.oronde@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2022-05-31 15:23:09 +02:00
CumulativeSumOptions
ARROW-13832: [Doc] Improve compute documentation Document a bit better the compute functions and add a section about grouped aggregations. Also list the available aggregation functions automatically. ![sshot2](https://user-images.githubusercontent.com/601423/144261429-90ca370c-8431-424b-9f6d-44a17846c055.png) Closes #11830 from amol-/ARROW-13832 Authored-by: Alessandro Molina <amol@turbogears.org> Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
2021-12-09 13:53:34 +01:00
DayOfWeekOptions
DictionaryEncodeOptions
ElementWiseAggregateOptions
ExtractRegexOptions
GH-48095: [Python][Docs] Add missing {pyarrow,compute} functions to API docs (#48117) Issue #48095 and #45322 ### Rationale for this change Missing API doc entries. ### What changes are included in this PR? I've added strings for functions and options to the API doc page. ### Are these changes tested? I've built docs locally. ### Are there any user-facing changes? Docs only. * GitHub Issue: #48095 * Also covers: #45322 Lead-authored-by: Tadeja Kadunc <tadeja.kadunc@gmail.com> Co-authored-by: tadeja <tadeja@users.noreply.github.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Signed-off-by: AlenkaF <frim.alenka@gmail.com>
2025-11-20 12:35:31 +01:00
ExtractRegexSpanOptions
ARROW-13832: [Doc] Improve compute documentation Document a bit better the compute functions and add a section about grouped aggregations. Also list the available aggregation functions automatically. ![sshot2](https://user-images.githubusercontent.com/601423/144261429-90ca370c-8431-424b-9f6d-44a17846c055.png) Closes #11830 from amol-/ARROW-13832 Authored-by: Alessandro Molina <amol@turbogears.org> Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
2021-12-09 13:53:34 +01:00
FilterOptions
IndexOptions
GH-48167: [Python][C++][Compute] Add python bindings for scatter, inverse_permutation (#48267) ### Rationale for this change To close or discuss #48167 `inverse_permutation` and `scatter` functions got implemented via #44393, PR #44394. ### What changes are included in this PR? Python tests for `scatter`, `inverse_permutation` kernels and bindings for `InversePermutationOptions` and `ScatterOptions`. ### Are these changes tested? Yes, tests added in test_compute.py. ### Are there any user-facing changes? Bindings for `InversePermutationOptions` and `ScatterOptions` are added. #### This PR includes breaking changes to public APIs. Options `InversePermutationOptions` changed from accepting parameter `std::shared_ptr<DataType> output_type = NULLPTR` to `std::optional<std::shared_ptr<DataType>> output_type = std::nullopt` * GitHub Issue: #48167 Lead-authored-by: Tadeja Kadunc <tadeja.kadunc@gmail.com> Co-authored-by: Rossi Sun <zanmato1984@gmail.com> Co-authored-by: tadeja <tadeja@users.noreply.github.com> Signed-off-by: Rossi Sun <zanmato1984@gmail.com>
2025-12-29 08:14:36 +01:00
InversePermutationOptions
ARROW-13832: [Doc] Improve compute documentation Document a bit better the compute functions and add a section about grouped aggregations. Also list the available aggregation functions automatically. ![sshot2](https://user-images.githubusercontent.com/601423/144261429-90ca370c-8431-424b-9f6d-44a17846c055.png) Closes #11830 from amol-/ARROW-13832 Authored-by: Alessandro Molina <amol@turbogears.org> Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
2021-12-09 13:53:34 +01:00
JoinOptions
GH-48095: [Python][Docs] Add missing {pyarrow,compute} functions to API docs (#48117) Issue #48095 and #45322 ### Rationale for this change Missing API doc entries. ### What changes are included in this PR? I've added strings for functions and options to the API doc page. ### Are these changes tested? I've built docs locally. ### Are there any user-facing changes? Docs only. * GitHub Issue: #48095 * Also covers: #45322 Lead-authored-by: Tadeja Kadunc <tadeja.kadunc@gmail.com> Co-authored-by: tadeja <tadeja@users.noreply.github.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Signed-off-by: AlenkaF <frim.alenka@gmail.com>
2025-11-20 12:35:31 +01:00
ListFlattenOptions
ARROW-17960: [C++][Python] Implement list_slice kernel (#14395) Will fix [ARROW-17960](https://issues.apache.org/jira/browse/ARROW-17960) Authored-by: Miles Granger <miles59923@gmail.com> Signed-off-by: David Li <li.davidm96@gmail.com>
2022-11-15 18:56:16 +01:00
ListSliceOptions
ARROW-13832: [Doc] Improve compute documentation Document a bit better the compute functions and add a section about grouped aggregations. Also list the available aggregation functions automatically. ![sshot2](https://user-images.githubusercontent.com/601423/144261429-90ca370c-8431-424b-9f6d-44a17846c055.png) Closes #11830 from amol-/ARROW-13832 Authored-by: Alessandro Molina <amol@turbogears.org> Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
2021-12-09 13:53:34 +01:00
MakeStructOptions
ARROW-15089: [C++][Compute] Implement kernel to lookup a MapArray item for a given key Implement a Scalar Kernel to lookup a value for a given key in a `MapArray`, whose type is an alias for `List(Struct(<key>, <item>))` Todo: - [x] Add more tests and combinations (Do suggest more) - [x] `null` maps - [x] empty maps - [x] `null` items - [x] `null` non-empty items Types tested: - [x] PhysicalIntegralArrowTypes - [x] DecimalArrowTypes - [x] BaseBinaryArrowTypes - [x] Boolean - [x] FixedSizeString - [x] MonthDayNanoInterval - [x] Template Kernel Things to consider: - [x] Looking up `null` keys. (Null keys are not allowed) Closes #12162 from dhruv9vats/arrow-15089-test Lead-authored-by: Dhruv Vats <dhruv25vats@gmail.com> Co-authored-by: Dhruv Vats <dhruv@Dhruvs-MacBook-Pro.local> Signed-off-by: David Li <li.davidm96@gmail.com>
2022-02-03 08:38:33 -05:00
MapLookupOptions
ARROW-13832: [Doc] Improve compute documentation Document a bit better the compute functions and add a section about grouped aggregations. Also list the available aggregation functions automatically. ![sshot2](https://user-images.githubusercontent.com/601423/144261429-90ca370c-8431-424b-9f6d-44a17846c055.png) Closes #11830 from amol-/ARROW-13832 Authored-by: Alessandro Molina <amol@turbogears.org> Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
2021-12-09 13:53:34 +01:00
MatchSubstringOptions
ModeOptions
NullOptions
PadOptions
GH-35786: [C++] Add pairwise_diff function (#35787) ### Rationale for this change Add a `pairwise_diff` function similar to pandas' [Series.Diff](https://pandas.pydata.org/docs/reference/api/pandas.Series.diff.html), the function computes the first order difference of an array. ### What changes are included in this PR? I followed [these instructions](https://github.com/apache/arrow/pull/12460#issuecomment-1057520554). The function is implemented for numerical, temporal and decimal types. Chuck arrays are not yet supported. ### Are these changes tested? Yes. They are tested in vector_pairwise_test.cc and in python/pyarrow/tests/compute.py. ### Are there any user-facing changes? Yes, and docs are also updated in this PR. * Closes: #35786 Lead-authored-by: Jin Shang <shangjin1997@gmail.com> Co-authored-by: Benjamin Kietzman <bengilgit@gmail.com> Signed-off-by: Benjamin Kietzman <bengilgit@gmail.com>
2023-06-29 20:43:23 +08:00
PairwiseOptions
ARROW-13832: [Doc] Improve compute documentation Document a bit better the compute functions and add a section about grouped aggregations. Also list the available aggregation functions automatically. ![sshot2](https://user-images.githubusercontent.com/601423/144261429-90ca370c-8431-424b-9f6d-44a17846c055.png) Closes #11830 from amol-/ARROW-13832 Authored-by: Alessandro Molina <amol@turbogears.org> Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
2021-12-09 13:53:34 +01:00
PartitionNthOptions
GH-45269: [C++][Compute] Add "pivot_wider" and "hash_pivot_wider" functions (#45562) ### Rationale for this change Add "pivot wider" functionality such as [in Pandas](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.pivot.html), through two dedicated functions: 1. a "pivot_wider" scalar aggregate function returning a Struct scalar 2. a "hash_pivot_wider" grouped aggregate function returning a Struct array Both functions take two arguments (the column of pivot keys and the column of pivot values) and require passing a `PivotWiderOptions` structure with the expected pivot keys, so as to determine the output Struct type. ### Are these changes tested? Yes, by dedicated unit tests. ### Are there any user-facing changes? No, just new APIs. * GitHub Issue: #45269 Authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2025-03-04 17:21:38 +01:00
PivotWiderOptions
ARROW-13832: [Doc] Improve compute documentation Document a bit better the compute functions and add a section about grouped aggregations. Also list the available aggregation functions automatically. ![sshot2](https://user-images.githubusercontent.com/601423/144261429-90ca370c-8431-424b-9f6d-44a17846c055.png) Closes #11830 from amol-/ARROW-13832 Authored-by: Alessandro Molina <amol@turbogears.org> Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
2021-12-09 13:53:34 +01:00
QuantileOptions
GH-48095: [Python][Docs] Add missing {pyarrow,compute} functions to API docs (#48117) Issue #48095 and #45322 ### Rationale for this change Missing API doc entries. ### What changes are included in this PR? I've added strings for functions and options to the API doc page. ### Are these changes tested? I've built docs locally. ### Are there any user-facing changes? Docs only. * GitHub Issue: #48095 * Also covers: #45322 Lead-authored-by: Tadeja Kadunc <tadeja.kadunc@gmail.com> Co-authored-by: tadeja <tadeja@users.noreply.github.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Signed-off-by: AlenkaF <frim.alenka@gmail.com>
2025-11-20 12:35:31 +01:00
RandomOptions
RankOptions
RankQuantileOptions
ARROW-13832: [Doc] Improve compute documentation Document a bit better the compute functions and add a section about grouped aggregations. Also list the available aggregation functions automatically. ![sshot2](https://user-images.githubusercontent.com/601423/144261429-90ca370c-8431-424b-9f6d-44a17846c055.png) Closes #11830 from amol-/ARROW-13832 Authored-by: Alessandro Molina <amol@turbogears.org> Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
2021-12-09 13:53:34 +01:00
ReplaceSliceOptions
ReplaceSubstringOptions
GH-48095: [Python][Docs] Add missing {pyarrow,compute} functions to API docs (#48117) Issue #48095 and #45322 ### Rationale for this change Missing API doc entries. ### What changes are included in this PR? I've added strings for functions and options to the API doc page. ### Are these changes tested? I've built docs locally. ### Are there any user-facing changes? Docs only. * GitHub Issue: #48095 * Also covers: #45322 Lead-authored-by: Tadeja Kadunc <tadeja.kadunc@gmail.com> Co-authored-by: tadeja <tadeja@users.noreply.github.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Signed-off-by: AlenkaF <frim.alenka@gmail.com>
2025-11-20 12:35:31 +01:00
RoundBinaryOptions
ARROW-13832: [Doc] Improve compute documentation Document a bit better the compute functions and add a section about grouped aggregations. Also list the available aggregation functions automatically. ![sshot2](https://user-images.githubusercontent.com/601423/144261429-90ca370c-8431-424b-9f6d-44a17846c055.png) Closes #11830 from amol-/ARROW-13832 Authored-by: Alessandro Molina <amol@turbogears.org> Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
2021-12-09 13:53:34 +01:00
RoundOptions
ARROW-14822: [C++] Implement floor/ceil/round for temporal objects This is to resolve [ARROW-14822](https://issues.apache.org/jira/browse/ARROW-14822). Closes #11818 from rok/ARROW-14822 Authored-by: Rok <rok@mihevc.org> Signed-off-by: David Li <li.davidm96@gmail.com>
2022-01-04 16:31:01 -05:00
RoundTemporalOptions
ARROW-13832: [Doc] Improve compute documentation Document a bit better the compute functions and add a section about grouped aggregations. Also list the available aggregation functions automatically. ![sshot2](https://user-images.githubusercontent.com/601423/144261429-90ca370c-8431-424b-9f6d-44a17846c055.png) Closes #11830 from amol-/ARROW-13832 Authored-by: Alessandro Molina <amol@turbogears.org> Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
2021-12-09 13:53:34 +01:00
RoundToMultipleOptions
GH-34568: [C++][Python] Expose Run-End Encoded arrays in Python Arrow (#34570) * Closes: #34568 Authored-by: Felipe Oliveira Carvalho <felipekde@gmail.com> Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
2023-03-23 05:20:06 -03:00
RunEndEncodeOptions
ARROW-13832: [Doc] Improve compute documentation Document a bit better the compute functions and add a section about grouped aggregations. Also list the available aggregation functions automatically. ![sshot2](https://user-images.githubusercontent.com/601423/144261429-90ca370c-8431-424b-9f6d-44a17846c055.png) Closes #11830 from amol-/ARROW-13832 Authored-by: Alessandro Molina <amol@turbogears.org> Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
2021-12-09 13:53:34 +01:00
ScalarAggregateOptions
GH-48167: [Python][C++][Compute] Add python bindings for scatter, inverse_permutation (#48267) ### Rationale for this change To close or discuss #48167 `inverse_permutation` and `scatter` functions got implemented via #44393, PR #44394. ### What changes are included in this PR? Python tests for `scatter`, `inverse_permutation` kernels and bindings for `InversePermutationOptions` and `ScatterOptions`. ### Are these changes tested? Yes, tests added in test_compute.py. ### Are there any user-facing changes? Bindings for `InversePermutationOptions` and `ScatterOptions` are added. #### This PR includes breaking changes to public APIs. Options `InversePermutationOptions` changed from accepting parameter `std::shared_ptr<DataType> output_type = NULLPTR` to `std::optional<std::shared_ptr<DataType>> output_type = std::nullopt` * GitHub Issue: #48167 Lead-authored-by: Tadeja Kadunc <tadeja.kadunc@gmail.com> Co-authored-by: Rossi Sun <zanmato1984@gmail.com> Co-authored-by: tadeja <tadeja@users.noreply.github.com> Signed-off-by: Rossi Sun <zanmato1984@gmail.com>
2025-12-29 08:14:36 +01:00
ScatterOptions
ARROW-13832: [Doc] Improve compute documentation Document a bit better the compute functions and add a section about grouped aggregations. Also list the available aggregation functions automatically. ![sshot2](https://user-images.githubusercontent.com/601423/144261429-90ca370c-8431-424b-9f6d-44a17846c055.png) Closes #11830 from amol-/ARROW-13832 Authored-by: Alessandro Molina <amol@turbogears.org> Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
2021-12-09 13:53:34 +01:00
SelectKOptions
SetLookupOptions
GH-48095: [Python][Docs] Add missing {pyarrow,compute} functions to API docs (#48117) Issue #48095 and #45322 ### Rationale for this change Missing API doc entries. ### What changes are included in this PR? I've added strings for functions and options to the API doc page. ### Are these changes tested? I've built docs locally. ### Are there any user-facing changes? Docs only. * GitHub Issue: #48095 * Also covers: #45322 Lead-authored-by: Tadeja Kadunc <tadeja.kadunc@gmail.com> Co-authored-by: tadeja <tadeja@users.noreply.github.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Signed-off-by: AlenkaF <frim.alenka@gmail.com>
2025-11-20 12:35:31 +01:00
SkewOptions
ARROW-13832: [Doc] Improve compute documentation Document a bit better the compute functions and add a section about grouped aggregations. Also list the available aggregation functions automatically. ![sshot2](https://user-images.githubusercontent.com/601423/144261429-90ca370c-8431-424b-9f6d-44a17846c055.png) Closes #11830 from amol-/ARROW-13832 Authored-by: Alessandro Molina <amol@turbogears.org> Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
2021-12-09 13:53:34 +01:00
SliceOptions
SortOptions
SplitOptions
SplitPatternOptions
StrftimeOptions
StrptimeOptions
StructFieldOptions
TakeOptions
TDigestOptions
TrimOptions
GH-48095: [Python][Docs] Add missing {pyarrow,compute} functions to API docs (#48117) Issue #48095 and #45322 ### Rationale for this change Missing API doc entries. ### What changes are included in this PR? I've added strings for functions and options to the API doc page. ### Are these changes tested? I've built docs locally. ### Are there any user-facing changes? Docs only. * GitHub Issue: #48095 * Also covers: #45322 Lead-authored-by: Tadeja Kadunc <tadeja.kadunc@gmail.com> Co-authored-by: tadeja <tadeja@users.noreply.github.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Signed-off-by: AlenkaF <frim.alenka@gmail.com>
2025-11-20 12:35:31 +01:00
Utf8NormalizeOptions
ARROW-13832: [Doc] Improve compute documentation Document a bit better the compute functions and add a section about grouped aggregations. Also list the available aggregation functions automatically. ![sshot2](https://user-images.githubusercontent.com/601423/144261429-90ca370c-8431-424b-9f6d-44a17846c055.png) Closes #11830 from amol-/ARROW-13832 Authored-by: Alessandro Molina <amol@turbogears.org> Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
2021-12-09 13:53:34 +01:00
VarianceOptions
ARROW-15032: [C++] Add year_month_day function Adds a year_month_day function for temporal inputs Closes #11990 from WillAyd/add-ymd-func Lead-authored-by: William Ayd <william.ayd@icloud.com> Co-authored-by: William Ayd <will_ayd@innobi.io> Signed-off-by: David Li <li.davidm96@gmail.com>
2022-01-04 20:35:24 -05:00
WeekOptions
GH-48095: [Python][Docs] Add missing {pyarrow,compute} functions to API docs (#48117) Issue #48095 and #45322 ### Rationale for this change Missing API doc entries. ### What changes are included in this PR? I've added strings for functions and options to the API doc page. ### Are these changes tested? I've built docs locally. ### Are there any user-facing changes? Docs only. * GitHub Issue: #48095 * Also covers: #45322 Lead-authored-by: Tadeja Kadunc <tadeja.kadunc@gmail.com> Co-authored-by: tadeja <tadeja@users.noreply.github.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Signed-off-by: AlenkaF <frim.alenka@gmail.com>
2025-11-20 12:35:31 +01:00
WinsorizeOptions
ZeroFillOptions
Functions Registry
------------------
.. autosummary::
:toctree: ../generated/
call_function
call_tabular_function
get_function
list_functions
ARROW-17181: [Docs][Python] Scalar UDF Experimental Documentation (#13687) This PR contains Python Scalar UDF documentation as an experimental version of docs. At the moment we only support Scalar UDFs and the code snippets include how to use UDFs with PyArrow. Lead-authored-by: Vibhatha Abeykoon <vibhatha@gmail.com> Co-authored-by: Vibhatha Lakmal Abeykoon <vibhatha@users.noreply.github.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2022-09-29 14:11:46 +05:30
User-Defined Functions
----------------------
.. autosummary::
:toctree: ../generated/
GH-48095: [Python][Docs] Add missing {pyarrow,compute} functions to API docs (#48117) Issue #48095 and #45322 ### Rationale for this change Missing API doc entries. ### What changes are included in this PR? I've added strings for functions and options to the API doc page. ### Are these changes tested? I've built docs locally. ### Are there any user-facing changes? Docs only. * GitHub Issue: #48095 * Also covers: #45322 Lead-authored-by: Tadeja Kadunc <tadeja.kadunc@gmail.com> Co-authored-by: tadeja <tadeja@users.noreply.github.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Signed-off-by: AlenkaF <frim.alenka@gmail.com>
2025-11-20 12:35:31 +01:00
register_aggregate_function
ARROW-17181: [Docs][Python] Scalar UDF Experimental Documentation (#13687) This PR contains Python Scalar UDF documentation as an experimental version of docs. At the moment we only support Scalar UDFs and the code snippets include how to use UDFs with PyArrow. Lead-authored-by: Vibhatha Abeykoon <vibhatha@gmail.com> Co-authored-by: Vibhatha Lakmal Abeykoon <vibhatha@users.noreply.github.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2022-09-29 14:11:46 +05:30
register_scalar_function
GH-48095: [Python][Docs] Add missing {pyarrow,compute} functions to API docs (#48117) Issue #48095 and #45322 ### Rationale for this change Missing API doc entries. ### What changes are included in this PR? I've added strings for functions and options to the API doc page. ### Are these changes tested? I've built docs locally. ### Are there any user-facing changes? Docs only. * GitHub Issue: #48095 * Also covers: #45322 Lead-authored-by: Tadeja Kadunc <tadeja.kadunc@gmail.com> Co-authored-by: tadeja <tadeja@users.noreply.github.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Signed-off-by: AlenkaF <frim.alenka@gmail.com>
2025-11-20 12:35:31 +01:00
register_tabular_function
register_vector_function
GH-39640: [Docs] Pin pydata-sphinx-theme to 0.14.* (#39758) ### Rationale for this change Fixing the pinning syntax so we get the latest 0.14.x version (which is currently 0.14.4) * Closes: #39640 Authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com> Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
2024-01-30 09:16:53 +01:00
UdfContext
GH-41985: [Python][Docs] Clarify docstring of pyarrow.compute.scalar() (#45668) ### Rationale for this change The current docstring for `pyarrow.compute.scalar()` is incomplete and potentially misleading. It states that it only accepts "a subset of types" when in reality it accepts any value that can be converted to a `pyarrow.Scalar`. Additionally, there's no clear explanation of the difference between `pyarrow.scalar()` and `pyarrow.compute.scalar()`, which can be confusing for users since both functions have the same name but serve different purposes. ### What changes are included in this PR? This PR updates the docstring for `pyarrow.compute.scalar()` to clarify that it accepts any value convertible to a `pyarrow.Scalar` and add a detailed explanation of the difference between `pyarrow.scalar()` and `pyarrow.compute.scalar()` ### Are these changes tested? via CI. ### Are there any user-facing changes? No. * GitHub Issue: #41985 Lead-authored-by: Chilin Chiou <chilin.chiou@gmail.com> Co-authored-by: ChiLin Chiu <chilin.chiou@gmail.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Co-authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com> Signed-off-by: AlenkaF <frim.alenka@gmail.com>
2025-03-31 03:59:41 +08:00
Expression Functions
--------------------
.. autosummary::
:toctree: ../generated/
field
scalar
Reference in New Issue Copy Permalink