Skip to content

Commit cf709ac

Browse files
committed
initial commit
1 parent f5b3fc7 commit cf709ac

File tree

1 file changed

+65
-1
lines changed

1 file changed

+65
-1
lines changed

docs/source/python/api/compute.rst

Lines changed: 65 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,11 @@ Aggregations
3232
approximate_median
3333
count
3434
count_distinct
35+
first
36+
first_last
3537
index
38+
kurtosis
39+
last
3640
max
3741
mean
3842
min
@@ -41,6 +45,7 @@ Aggregations
4145
pivot_wider
4246
product
4347
quantile
48+
skew
4449
stddev
4550
sum
4651
tdigest
@@ -69,6 +74,7 @@ throws an ``ArrowInvalid`` exception when overflow is detected.
6974
cumulative_prod
7075
cumulative_prod_checked
7176
cumulative_max
77+
cumulative_mean
7278
cumulative_min
7379

7480
Arithmetic Functions
@@ -126,6 +132,7 @@ representation based on the rounding criterion.
126132
ceil
127133
floor
128134
round
135+
round_binary
129136
round_to_multiple
130137
trunc
131138

@@ -171,6 +178,24 @@ variants which detect domain errors where appropriate.
171178
tan
172179
tan_checked
173180

181+
Hyperbolic Trigonometric Functions
182+
-----------------------
183+
184+
Hyperbolic trigonometric functions are also supported, and, where applicable, also offer ``_checked``
185+
variants which detect domain errors if needed.
186+
187+
.. autosummary::
188+
:toctree: ../generated/
189+
190+
acosh
191+
acosh_checked
192+
asinh
193+
atanh
194+
atanh_checked
195+
cosh
196+
sinh
197+
tanh
198+
174199
Comparisons
175200
-----------
176201

@@ -281,6 +306,7 @@ String Transforms
281306
utf8_capitalize
282307
utf8_length
283308
utf8_lower
309+
utf8_normalize
284310
utf8_replace_slice
285311
utf8_reverse
286312
utf8_swapcase
@@ -338,6 +364,7 @@ String Component Extraction
338364
:toctree: ../generated/
339365

340366
extract_regex
367+
extract_regex_span
341368

342369
String Joining
343370
--------------
@@ -369,7 +396,9 @@ Containment Tests
369396
find_substring
370397
find_substring_regex
371398
index_in
399+
index_in_meta_binary
372400
is_in
401+
is_in_meta_binary
373402
match_like
374403
match_substring
375404
match_substring_regex
@@ -425,10 +454,11 @@ Temporal Component Extraction
425454
day_of_week
426455
day_of_year
427456
hour
457+
is_dst
458+
is_leap_year
428459
iso_week
429460
iso_year
430461
iso_calendar
431-
is_leap_year
432462
microsecond
433463
millisecond
434464
minute
@@ -472,12 +502,21 @@ Timezone Handling
472502
assume_timezone
473503
local_timestamp
474504

505+
Random Number Generation
506+
-----------------
507+
508+
.. autosummary::
509+
:toctree: ../generated/
510+
511+
random
512+
475513
Associative Transforms
476514
----------------------
477515

478516
.. autosummary::
479517
:toctree: ../generated/
480518

519+
dictionary_decode
481520
dictionary_encode
482521
unique
483522
value_counts
@@ -492,7 +531,9 @@ Selections
492531
array_take
493532
drop_null
494533
filter
534+
inverse_permutation
495535
take
536+
scatter
496537

497538
Sorts and Partitions
498539
--------------------
@@ -501,9 +542,14 @@ Sorts and Partitions
501542
:toctree: ../generated/
502543

503544
array_sort_indices
545+
bottom_k_unstable
504546
partition_nth_indices
547+
rank
548+
rank_normal
549+
rank_quantile
505550
select_k_unstable
506551
sort_indices
552+
top_k_unstable
507553

508554
Structural Transforms
509555
---------------------
@@ -531,6 +577,7 @@ Pairwise Functions
531577
:toctree: ../generated/
532578

533579
pairwise_diff
580+
pairwise_diff_checked
534581

535582
Compute Options
536583
---------------
@@ -542,6 +589,7 @@ Compute Options
542589
AssumeTimezoneOptions
543590
CastOptions
544591
CountOptions
592+
CumulativeOptions
545593
CumulativeSumOptions
546594
DayOfWeekOptions
547595
DictionaryEncodeOptions
@@ -550,6 +598,7 @@ Compute Options
550598
FilterOptions
551599
IndexOptions
552600
JoinOptions
601+
ListFlattenOptions
553602
ListSliceOptions
554603
MakeStructOptions
555604
MapLookupOptions
@@ -562,15 +611,19 @@ Compute Options
562611
PartitionNthOptions
563612
PivotWiderOptions
564613
QuantileOptions
614+
RandomOptions
615+
RankQuantileOptions
565616
ReplaceSliceOptions
566617
ReplaceSubstringOptions
618+
RoundBinaryOptions
567619
RoundOptions
568620
RoundTemporalOptions
569621
RoundToMultipleOptions
570622
RunEndEncodeOptions
571623
ScalarAggregateOptions
572624
SelectKOptions
573625
SetLookupOptions
626+
SkewOptions
574627
SliceOptions
575628
SortOptions
576629
SplitOptions
@@ -581,8 +634,10 @@ Compute Options
581634
TakeOptions
582635
TDigestOptions
583636
TrimOptions
637+
Utf8NormalizeOptions
584638
VarianceOptions
585639
WeekOptions
640+
WinsorizeOptions
586641

587642
User-Defined Functions
588643
----------------------
@@ -593,6 +648,15 @@ User-Defined Functions
593648
register_scalar_function
594649
UdfContext
595650

651+
Statistical Functions
652+
----------------------
653+
654+
.. autosummary::
655+
:toctree: ../generated/
656+
657+
winsorize
658+
659+
596660
Expression Functions
597661
--------------------
598662

0 commit comments

Comments
 (0)