ak.contents.ListOffsetArray =========================== Defined in `awkward.contents.listoffsetarray `__ on `line 56 `__. .. py:class:: ak.contents.ListOffsetArray(offsets, content, *, parameters=None) ListOffsetArray describes unequal-length lists (often called a "jagged" or "ragged" array). Like :py:obj:`ak.contents.RegularArray`, the underlying data for all lists are in a contiguous ``content``. It is subdivided into lists according to an ``offsets`` buffer, which specifies the starting and stopping index of each list. The ``offsets`` must have at least length 1 (corresponding to an empty array), but it need not start with ``0`` or include all of the ``content``. Just as :py:obj:`ak.contents.RegularArray` can have unreachable ``content`` if it is not an integer multiple of ``size``, a ListOffsetArray can have unreachable content before the start of the first list and after the end of the last list. Like :py:obj:`ak.contents.RegularArray` and :py:obj:`ak.contents.ListArray`, a ListOffsetArray can represent strings if its ``__array__`` parameter is ``"string"`` (UTF-8 assumed) or ``"bytestring"`` (no encoding assumed) and it contains an :py:obj:`ak.contents.NumpyArray` of ``dtype=np.uint8`` whose ``__array__`` parameter is ``"char"`` (UTF-8 assumed) or ``"byte"`` (no encoding assumed). ListOffsetArray corresponds to Apache Arrow `List type `__. To illustrate how the constructor arguments are interpreted, the following is a simplified implementation of ``__init__``, ``__len__``, and ``__getitem__``:: class ListOffsetArray(Content): def __init__(self, offsets, content): assert isinstance(offsets, (Index32, IndexU32, Index64)) assert isinstance(content, Content) assert len(offsets) != 0 for i in range(len(offsets) - 1): start = offsets[i] stop = offsets[i + 1] if start != stop: assert start < stop # i.e. start <= stop assert start >= 0 assert stop <= len(content) self.offsets = offsets self.content = content def __len__(self): return len(self.offsets) - 1 def __getitem__(self, where): if isinstance(where, int): if where < 0: where += len(self) assert 0 <= where < len(self) return self.content[self.offsets[where] : self.offsets[where + 1]] elif isinstance(where, slice) and where.step is None: offsets = self.offsets[where.start : where.stop + 1] if len(offsets) == 0: offsets = [0] return ListOffsetArray(offsets, self.content) elif isinstance(where, str): return ListOffsetArray(self.offsets, self.content[where]) else: raise AssertionError(where) .. py:attribute:: _offsets .. py:attribute:: _content .. py:property:: offsets :type: awkward.index.Index .. py:attribute:: form_cls :type: awkward._typing.Final .. py:method:: copy(offsets=UNSET, content=UNSET, *, parameters=UNSET) .. py:method:: __copy__() .. py:method:: __deepcopy__(memo) .. py:method:: simplified(offsets, content, *, parameters=None) :classmethod: .. py:property:: starts :type: awkward.index.Index .. py:property:: stops .. py:method:: _form_with_key(getkey: awkward._typing.Callable[[awkward.contents.content.Content], str | None]) -> awkward.forms.listoffsetform.ListOffsetForm .. py:method:: _form_with_key_path(path: awkward.forms.form.FormKeyPathT) -> awkward.forms.listoffsetform.ListOffsetForm .. py:method:: _to_buffers(form: awkward.forms.form.Form, getkey: awkward._typing.Callable[[awkward.contents.content.Content, awkward.forms.form.Form, str], str], container: collections.abc.MutableMapping[str, awkward._nplikes.array_like.ArrayLike], backend: awkward._backends.backend.Backend, byteorder: str) .. py:method:: _to_typetracer(forget_length: bool) -> awkward._typing.Self .. py:method:: _touch_data(recursive: bool) .. py:method:: _touch_shape(recursive: bool) .. py:property:: length :type: awkward._nplikes.shape.ShapeItem .. py:method:: __repr__() .. py:method:: _repr(indent, pre, post) .. py:method:: to_ListOffsetArray64(start_at_zero: bool = False) -> ListOffsetArray .. py:method:: to_RegularArray() .. py:method:: _getitem_nothing() .. py:method:: _is_getitem_at_placeholder() -> bool .. py:method:: _is_getitem_at_virtual() -> bool .. py:method:: _getitem_at(where: awkward._nplikes.numpy_like.IndexType) .. py:method:: _getitem_range(start: awkward._nplikes.numpy_like.IndexType, stop: awkward._nplikes.numpy_like.IndexType) -> awkward.contents.content.Content .. py:method:: _getitem_field(where: str | awkward._typing.SupportsIndex, only_fields: tuple[str, Ellipsis] = ()) -> awkward.contents.content.Content .. py:method:: _getitem_fields(where: list[str | awkward._typing.SupportsIndex], only_fields: tuple[str, Ellipsis] = ()) -> awkward.contents.content.Content .. py:method:: _carry(carry: awkward.index.Index, allow_lazy: bool) -> awkward.contents.content.Content .. py:method:: _compact_offsets64(start_at_zero: bool) -> awkward.index.Index64 .. py:method:: _broadcast_tooffsets64(offsets: awkward.index.Index) -> ListOffsetArray .. py:method:: _getitem_next_jagged(slicestarts: awkward.index.Index, slicestops: awkward.index.Index, slicecontent: awkward.contents.content.Content, tail) -> awkward.contents.content.Content .. py:method:: _getitem_next(head: awkward._slicing.SliceItem | tuple, tail: tuple[awkward._slicing.SliceItem, Ellipsis], advanced: awkward.index.Index | None) -> awkward.contents.content.Content .. py:method:: _offsets_and_flattened(axis: int, depth: int) -> tuple[awkward.index.Index, awkward.contents.content.Content] .. py:method:: _mergeable_next(other: awkward.contents.content.Content, mergebool: bool, mergecastable: awkward._typing.Literal[same_kind, equiv, family]) -> bool .. py:method:: _mergemany(others: collections.abc.Sequence[awkward.contents.content.Content]) -> awkward.contents.content.Content .. py:method:: _fill_none(value: awkward.contents.content.Content) -> awkward.contents.content.Content .. py:method:: _local_index(axis, depth) .. py:method:: _numbers_to_type(name, including_unknown) .. py:method:: _is_unique(negaxis, starts, offsets, outlength) .. py:method:: _unique(negaxis, starts, offsets, outlength) .. py:method:: _argsort_next(negaxis, starts, shifts, offsets, outlength, ascending, stable) .. py:method:: _sort_next(negaxis, starts, offsets, outlength, ascending, stable) .. py:method:: _combinations(n, replacement, recordlookup, parameters, axis, depth) .. py:method:: _reduce_next(reducer, negaxis, starts, shifts, offsets, outlength, mask, keepdims, behavior) .. py:method:: _rearrange_prepare_next(outlength, offsets) .. py:method:: _validity_error(path) .. py:method:: _nbytes_part() .. py:method:: _pad_none(target, axis, depth, clip) .. py:method:: _to_arrow(pyarrow: awkward._typing.Any, mask_node: awkward.contents.content.Content | None, validbytes: awkward.contents.content.Content | None, length: int, options: awkward.contents.content.ToArrowOptions) .. py:method:: _to_cudf(cudf: awkward._typing.Any, mask: awkward.contents.content.Content | None, length: int) .. py:method:: _to_backend_array(allow_missing, backend) .. py:method:: _remove_structure(backend: awkward._backends.backend.Backend, options: awkward.contents.content.RemoveStructureOptions) -> list[awkward.contents.content.Content] .. py:method:: _drop_none() -> awkward.contents.content.Content .. py:method:: _rebuild_without_nones(none_indexes, new_content) .. py:method:: _recursively_apply(action: awkward.contents.content.ImplementsApplyAction, depth: int, depth_context: collections.abc.Mapping[str, awkward._typing.Any] | None, lateral_context: collections.abc.Mapping[str, awkward._typing.Any] | None, options: awkward.contents.content.ApplyActionOptions) -> awkward.contents.content.Content | None .. py:method:: _to_packed(recursive: bool = True) -> awkward._typing.Self .. py:method:: _to_list(behavior, json_conversions) .. py:method:: _to_backend(backend: awkward._backends.backend.Backend) -> awkward._typing.Self .. py:method:: _materialize(type_) -> awkward._typing.Self .. py:property:: _is_all_materialized :type: bool .. py:property:: _is_any_materialized :type: bool .. py:method:: _awkward_strings_to_nonfinite(nonfinit_dict) .. py:method:: _is_equal_to(other: awkward._typing.Self, index_dtype: bool, numpyarray: bool, all_parameters: bool) -> bool