Skip to main content
Ctrl+K
Logo image

Site Navigation

  • Getting started
  • User guide
  • API reference
  • Contributor guide
  • Release history

Site Navigation

  • Getting started
  • User guide
  • API reference
  • Contributor guide
  • Release history

Section Navigation

High-level data types

  • ak.Array
  • ak.Record

Append-only builder

  • ak.ArrayBuilder

Converting from other formats

  • ak.from_arrow
  • ak.from_arrow_schema
  • ak.from_avro_file
  • ak.from_buffers
  • ak.from_cupy
  • ak.from_iter
  • ak.from_jax
  • ak.from_json
  • ak.from_numpy
  • ak.from_parquet
  • ak.from_rdataframe
  • ak.from_avro_file
  • ak.metadata_from_parquet

Converting to other formats

  • ak.to_arrow
  • ak.to_arrow_table
  • ak.to_buffers
  • ak.to_cupy
  • ak.to_dataframe
  • ak.to_jax
  • ak.to_json
  • ak.to_list
  • ak.to_numpy
  • ak.to_packed
  • ak.to_parquet
  • ak.to_rdataframe

Correctness checking

  • ak.is_valid
  • ak.validity_error

Lengths of lists

  • ak.num
  • ak.count
  • ak.count_nonzero

Making and breaking records (columns)

  • ak.zip
  • ak.unzip

Merging arrays (rows)

  • ak.concatenate
  • ak.where

Flattening lists and missing values

  • ak.flatten
  • ak.unflatten
  • ak.ravel

Functions that reduce dimension

  • ak.all
  • ak.any
  • ak.sum
  • ak.prod
  • ak.max
  • ak.min
  • ak.argmax
  • ak.argmin
  • ak.nansum
  • ak.nanprod
  • ak.nanmax
  • ak.nanmin
  • ak.nanargmax
  • ak.nanargmin

Statistics that reduce dimension

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

Sorting

  • ak.sort
  • ak.argsort

Missing value handling

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

Ragged and regular dimensions

  • ak.to_regular
  • ak.from_regular

Broadcasting

  • ak.broadcast_arrays

Combinatorics ("for loop" replacements)

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

Value and type conversions

  • ak.nan_to_none
  • ak.nan_to_num
  • ak.values_astype
  • ak.strings_astype

Arrays of categorical data

  • ak.to_categorical
  • ak.from_categorical
  • ak.is_categorical
  • ak.categories

Indexing and grouping

  • ak.local_index
  • ak.run_lengths

Restructuring records

  • ak.merge_union_of_records
  • ak.merge_option_of_records

Copying and packing arrays

  • ak.copy
  • ak.to_packed

Extracting metadata

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

Manipulating metadata

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

Overriding behavior

  • ak.behavior
  • ak.mixin_class
  • ak.mixin_class_method

Computational backends

  • ak.to_backend
  • ak.backend

NumPy compatibility

  • ak.full_like
  • ak.isclose
  • ak.ones_like
  • ak.zeros_like

Array comparison

  • ak.almost_equal

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

Array layout transformations

  • ak.transform

Low-level array layouts

  • ak.to_layout
  • 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

Index for layout nodes

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

High-level data types

  • ak.types.from_datashape
  • 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.is_primitive
  • ak.types.dtype_to_primitive
  • ak.types.primitive_to_dtype

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

Builtin behaviors

  • ak.ByteBehavior
  • ak.ByteStringBehavior
  • ak.CharBehavior
  • ak.StringBehavior
  • ak.CategoricalBehavior

AwkwardForth for data ingest

  • AwkwardForth virtual machines

Low-level kernels

  • Kernel interface and specification
  • API reference
  • ak.StringBehavior

ak.StringBehavior#

Defined in awkward.behaviors.string on line 102.

class ak.StringBehavior(self)#
ak.StringBehavior.__name__ = 'Array'#
ak.StringBehavior.__iter__(self)#

previous

ak.CharBehavior

next

ak.CategoricalBehavior
Edit on GitHub
Show Source

© Copyright 2022, Awkward Array development team.

Created using Sphinx 4.5.0.

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

Built with the PyData Sphinx Theme 0.13.3.