Skip to main content

Ctrl+K

Getting started
User guide
API reference
Contributor guide
Release history

GitHub
PyPI
Gitter

Getting started
User guide
API reference
Contributor guide
Release history

GitHub
PyPI
Gitter

Section Navigation

High-level data types

ak.Array
ak.Record

Converting untyped data

ak.from_iter
ak.to_list
ak.from_json
ak.to_json

Converting rectangular arrays

ak.from_numpy
ak.to_numpy
ak.from_cupy
ak.to_cupy
ak.from_dlpack
ak.from_jax
ak.to_jax

Reading and writing files

ak.from_parquet
ak.metadata_from_parquet
ak.to_parquet
ak.to_parquet_dataset
ak.to_parquet_row_groups
ak.from_arrow
ak.from_arrow_schema
ak.to_arrow
ak.to_arrow_table
ak.from_feather
ak.to_feather
ak.from_avro_file

Converting to Pandas DataFrames

ak.to_dataframe

Converting ROOT RDataFrames

ak.from_rdataframe
ak.to_rdataframe

Append-only builder

ak.ArrayBuilder

Low-level conversion primitives

ak.from_buffers
ak.to_buffers
ak.to_packed
ak.copy

Validity checking

ak.is_valid
ak.validity_error

Restructuring records (columns)

ak.zip
ak.unzip
ak.merge_union_of_records
ak.merge_option_of_records

Merging arrays (rows)

ak.concatenate
ak.where

Flattening lists and missing values

ak.flatten
ak.unflatten
ak.ravel

Lengths of lists

ak.num
ak.count

Reducers

ak.count_nonzero
ak.sum
ak.nansum
ak.prod
ak.nanprod
ak.any
ak.all

Minimum and maximum

ak.min
ak.nanmin
ak.max
ak.nanmax
ak.argmin
ak.nanargmin
ak.argmax
ak.nanargmax

Descriptive statistics

ak.moment
ak.mean
ak.nanmean
ak.var
ak.nanvar
ak.std
ak.nanstd
ak.covar
ak.corr
ak.linear_fit
ak.ptp
ak.softmax

Sorting

ak.sort
ak.argsort

Missing value handling

ak.mask
ak.is_none
ak.drop_none
ak.pad_none
ak.fill_none
ak.firsts
ak.singletons

Ragged and regular dimensions

ak.from_regular
ak.to_regular

Broadcasting

ak.broadcast_arrays
ak.broadcast_fields

Combinatorics ("for loop" replacements)

ak.cartesian
ak.argcartesian
ak.combinations
ak.argcombinations

String predicates

ak.str.is_alnum
ak.str.is_alpha
ak.str.is_ascii
ak.str.is_decimal
ak.str.is_digit
ak.str.is_lower
ak.str.is_numeric
ak.str.is_printable
ak.str.is_space
ak.str.is_title
ak.str.is_upper

String transforms

ak.str.capitalize
ak.str.length
ak.str.lower
ak.str.repeat
ak.str.replace_slice
ak.str.replace_substring
ak.str.replace_substring_regex
ak.str.reverse
ak.str.swapcase
ak.str.title
ak.str.upper

String padding and trimming

ak.str.center
ak.str.lpad
ak.str.rpad
ak.str.ltrim
ak.str.ltrim_whitespace
ak.str.rtrim
ak.str.rtrim_whitespace
ak.str.trim
ak.str.trim_whitespace

String splitting and joining

ak.str.split_pattern
ak.str.split_pattern_regex
ak.str.split_whitespace
ak.str.join
ak.str.join_element_wise

String slicing and decomposition

ak.str.slice
ak.str.extract_regex

String containment tests

ak.str.count_substring
ak.str.count_substring_regex
ak.str.ends_with
ak.str.find_substring
ak.str.find_substring_regex
ak.str.index_in
ak.str.is_in
ak.str.match_like
ak.str.match_substring
ak.str.match_substring_regex
ak.str.starts_with

Value and type conversions

ak.enforce_type
ak.nan_to_none
ak.nan_to_num
ak.values_astype
ak.strings_astype

Arrays of categorical data

ak.from_categorical
ak.is_categorical
ak.categories
ak.str.to_categorical

Indexing and grouping

ak.local_index
ak.run_lengths

Extracting type metadata

ak.type
ak.parameters
ak.fields
ak.is_tuple

Manipulating type metadata

ak.with_name
ak.with_field
ak.without_field
ak.with_parameter
ak.without_parameters

Overriding behavior

ak.behavior
ak.mixin_class
ak.mixin_class_method

Computational backends

ak.to_backend
ak.backend

Approximation and comparison

ak.round
ak.isclose
ak.almost_equal
ak.array_equal

NumPy compatibility

ak.real
ak.imag
ak.angle
ak.zeros_like
ak.ones_like
ak.full_like

Third-party integration

ak.numba.register_and_check
ak.jax.assert_registered
ak.jax.import_jax
ak.jax.register_and_check
ak.jax.register_behavior_class

High-level data types

ak.types.Type
ak.types.ArrayType
ak.types.ScalarType
ak.types.ListType
ak.types.NumpyType
ak.types.OptionType
ak.types.RecordType
ak.types.RegularType
ak.types.UnionType
ak.types.UnknownType
ak.types.from_datashape
ak.types.is_primitive
ak.types.primitive_to_dtype
ak.types.dtype_to_primitive

Low-level array layouts

ak.contents.Content
ak.contents.BitMaskedArray
ak.contents.ByteMaskedArray
ak.contents.EmptyArray
ak.contents.IndexedArray
ak.contents.IndexedOptionArray
ak.contents.ListArray
ak.contents.ListOffsetArray
ak.contents.NumpyArray
ak.contents.RecordArray
ak.contents.RegularArray
ak.contents.UnionArray
ak.contents.UnmaskedArray
ak.record.Record
ak.to_layout
ak.transform

Index for layout nodes

ak.index.Index
ak.index.Index8
ak.index.IndexU8
ak.index.Index32
ak.index.IndexU32
ak.index.Index64

Low-level types: "forms"

ak.forms.Form
ak.forms.BitMaskedForm
ak.forms.ByteMaskedForm
ak.forms.EmptyForm
ak.forms.IndexedForm
ak.forms.IndexedOptionForm
ak.forms.ListForm
ak.forms.ListOffsetForm
ak.forms.NumpyForm
ak.forms.RecordForm
ak.forms.RegularForm
ak.forms.UnionForm
ak.forms.UnmaskedForm
ak.forms.from_dict
ak.forms.from_json
ak.forms.from_type

Low-level data ingest

AwkwardForth virtual machines

Low-level kernels

Kernel interface and specification

API reference
ak.types.is_...

ak.types.is_primitive#

Defined in awkward.types.numpytype on line 19.

ak.types.is_primitive(primitive)#

previous

ak.types.from_datashape

next

ak.types.primitive_to_dtype

On this page

ak.types.is_primitive()

© Copyright 2022, Awkward Array development team.

Created using Sphinx 7.4.7.

Support for this work was provided by NSF cooperative agreement OAC-1836650 (IRIS-HEP 1), PHY-2323298 (IRIS-HEP 2), grant OAC-1450377 (DIANA/HEP), PHY-1520942 and PHY-2121686 (US-CMS LHC Ops), and OAC-2103945 (Awkward Array).

Built with the PyData Sphinx Theme 0.15.4.