ak.contents.UnmaskedArray
-------------------------

.. py:module: ak.contents.UnmaskedArray

Defined in `awkward.contents.unmaskedarray <https://github.com/scikit-hep/awkward/blob/0e052cbbf0a947fa88834710ee63a15582a0da63/src/awkward/contents/unmaskedarray.py>`__ on `line 55 <https://github.com/scikit-hep/awkward/blob/0e052cbbf0a947fa88834710ee63a15582a0da63/src/awkward/contents/unmaskedarray.py#L55>`__.

.. py:class:: ak.contents.UnmaskedArray(self, content, *, parameters=None)

UnmaskedArray implements an :py:obj:`ak.types.OptionType` for which the values are
never, in fact, missing. It exists to satisfy systems that formally require this
high-level type without the overhead of generating an array of all True or all
False values.

This is like NumPy's
`masked arrays <https://docs.scipy.org/doc/numpy/reference/maskedarray.html>`__
with ``mask=None``.

It is also like Apache Arrow's
`validity bitmaps <https://arrow.apache.org/docs/format/Columnar.html#validity-bitmaps>`__
because the bitmap can be omitted when all values are valid.

To illustrate how the constructor arguments are interpreted, the following is a
simplified implementation of ``__init__``, ``__len__``, and ``__getitem__``:

.. code-block:: python


    class UnmaskedArray(Content):
        def __init__(self, content):
            assert isinstance(content, Content)
            self.content = content

        def __len__(self):
            return len(self.content)

        def __getitem__(self, where):
            if isinstance(where, int):
                return self.content[where]
            else:
                return UnmaskedArray(self.content[where])



.. _ak-contents-unmaskedarray-copy:

.. py:method:: ak.contents.UnmaskedArray.copy(self, content=UNSET, *, parameters=UNSET)



.. _ak-contents-unmaskedarray-__copy__:

.. py:method:: ak.contents.UnmaskedArray.__copy__(self)



.. _ak-contents-unmaskedarray-__deepcopy__:

.. py:method:: ak.contents.UnmaskedArray.__deepcopy__(self, memo)



.. _ak-contents-unmaskedarray-simplified:

.. py:method:: ak.contents.UnmaskedArray.simplified(cls, content, *, parameters=None)



.. _ak-contents-unmaskedarray-_form_with_key:

.. py:method:: ak.contents.UnmaskedArray._form_with_key(self, getkey)



.. _ak-contents-unmaskedarray-_form_with_key_path:

.. py:method:: ak.contents.UnmaskedArray._form_with_key_path(self, path)



.. _ak-contents-unmaskedarray-_to_buffers:

.. py:method:: ak.contents.UnmaskedArray._to_buffers(self, form, getkey, container, backend, byteorder)



.. _ak-contents-unmaskedarray-_to_typetracer:

.. py:method:: ak.contents.UnmaskedArray._to_typetracer(self, forget_length)



.. _ak-contents-unmaskedarray-_touch_data:

.. py:method:: ak.contents.UnmaskedArray._touch_data(self, recursive)



.. _ak-contents-unmaskedarray-_touch_shape:

.. py:method:: ak.contents.UnmaskedArray._touch_shape(self, recursive)



.. _ak-contents-unmaskedarray-length:

.. py:attribute:: ak.contents.UnmaskedArray.length



.. _ak-contents-unmaskedarray-__repr__:

.. py:method:: ak.contents.UnmaskedArray.__repr__(self)



.. _ak-contents-unmaskedarray-_repr:

.. py:method:: ak.contents.UnmaskedArray._repr(self, indent, pre, post)



.. _ak-contents-unmaskedarray-to_indexedoptionarray64:

.. py:method:: ak.contents.UnmaskedArray.to_IndexedOptionArray64(self)



.. _ak-contents-unmaskedarray-to_bytemaskedarray:

.. py:method:: ak.contents.UnmaskedArray.to_ByteMaskedArray(self, valid_when)



.. _ak-contents-unmaskedarray-to_bitmaskedarray:

.. py:method:: ak.contents.UnmaskedArray.to_BitMaskedArray(self, valid_when, lsb_order)



.. _ak-contents-unmaskedarray-mask_as_bool:

.. py:method:: ak.contents.UnmaskedArray.mask_as_bool(self, valid_when=True)



.. _ak-contents-unmaskedarray-_getitem_nothing:

.. py:method:: ak.contents.UnmaskedArray._getitem_nothing(self)



.. _ak-contents-unmaskedarray-_is_getitem_at_placeholder:

.. py:method:: ak.contents.UnmaskedArray._is_getitem_at_placeholder(self)



.. _ak-contents-unmaskedarray-_getitem_at:

.. py:method:: ak.contents.UnmaskedArray._getitem_at(self, where)



.. _ak-contents-unmaskedarray-_getitem_range:

.. py:method:: ak.contents.UnmaskedArray._getitem_range(self, start, stop)



.. _ak-contents-unmaskedarray-_getitem_field:

.. py:method:: ak.contents.UnmaskedArray._getitem_field(self, where, only_fields=())



.. _ak-contents-unmaskedarray-_getitem_fields:

.. py:method:: ak.contents.UnmaskedArray._getitem_fields(self, where, only_fields=())



.. _ak-contents-unmaskedarray-_carry:

.. py:method:: ak.contents.UnmaskedArray._carry(self, carry, allow_lazy)



.. _ak-contents-unmaskedarray-_nextcarry_outindex:

.. py:method:: ak.contents.UnmaskedArray._nextcarry_outindex(self)



.. _ak-contents-unmaskedarray-_getitem_next_jagged:

.. py:method:: ak.contents.UnmaskedArray._getitem_next_jagged(self, slicestarts, slicestops, slicecontent, tail)



.. _ak-contents-unmaskedarray-_getitem_next:

.. py:method:: ak.contents.UnmaskedArray._getitem_next(self, head, tail, advanced)



.. _ak-contents-unmaskedarray-project:

.. py:method:: ak.contents.UnmaskedArray.project(self, mask=None)



.. _ak-contents-unmaskedarray-_offsets_and_flattened:

.. py:method:: ak.contents.UnmaskedArray._offsets_and_flattened(self, axis, depth)



.. _ak-contents-unmaskedarray-_mergeable_next:

.. py:method:: ak.contents.UnmaskedArray._mergeable_next(self, other, mergebool)



.. _ak-contents-unmaskedarray-_reverse_merge:

.. py:method:: ak.contents.UnmaskedArray._reverse_merge(self, other)



.. _ak-contents-unmaskedarray-_mergemany:

.. py:method:: ak.contents.UnmaskedArray._mergemany(self, others)



.. _ak-contents-unmaskedarray-_fill_none:

.. py:method:: ak.contents.UnmaskedArray._fill_none(self, value)



.. _ak-contents-unmaskedarray-_local_index:

.. py:method:: ak.contents.UnmaskedArray._local_index(self, axis, depth)



.. _ak-contents-unmaskedarray-_numbers_to_type:

.. py:method:: ak.contents.UnmaskedArray._numbers_to_type(self, name, including_unknown)



.. _ak-contents-unmaskedarray-_is_unique:

.. py:method:: ak.contents.UnmaskedArray._is_unique(self, negaxis, starts, parents, outlength)



.. _ak-contents-unmaskedarray-_unique:

.. py:method:: ak.contents.UnmaskedArray._unique(self, negaxis, starts, parents, outlength)



.. _ak-contents-unmaskedarray-_argsort_next:

.. py:method:: ak.contents.UnmaskedArray._argsort_next(self, negaxis, starts, shifts, parents, outlength, ascending, stable)



.. _ak-contents-unmaskedarray-_sort_next:

.. py:method:: ak.contents.UnmaskedArray._sort_next(self, negaxis, starts, parents, outlength, ascending, stable)



.. _ak-contents-unmaskedarray-_combinations:

.. py:method:: ak.contents.UnmaskedArray._combinations(self, n, replacement, recordlookup, parameters, axis, depth)



.. _ak-contents-unmaskedarray-_reduce_next:

.. py:method:: ak.contents.UnmaskedArray._reduce_next(self, reducer, negaxis, starts, shifts, parents, outlength, mask, keepdims, behavior)



.. _ak-contents-unmaskedarray-_validity_error:

.. py:method:: ak.contents.UnmaskedArray._validity_error(self, path)



.. _ak-contents-unmaskedarray-_nbytes_part:

.. py:method:: ak.contents.UnmaskedArray._nbytes_part(self)



.. _ak-contents-unmaskedarray-_pad_none:

.. py:method:: ak.contents.UnmaskedArray._pad_none(self, target, axis, depth, clip)



.. _ak-contents-unmaskedarray-_to_arrow:

.. py:method:: ak.contents.UnmaskedArray._to_arrow(self, pyarrow, mask_node, validbytes, length, options)



.. _ak-contents-unmaskedarray-_to_cudf:

.. py:method:: ak.contents.UnmaskedArray._to_cudf(self, cudf, mask, length)



.. _ak-contents-unmaskedarray-_to_backend_array:

.. py:method:: ak.contents.UnmaskedArray._to_backend_array(self, allow_missing, backend)



.. _ak-contents-unmaskedarray-_remove_structure:

.. py:method:: ak.contents.UnmaskedArray._remove_structure(self, backend, options)



.. _ak-contents-unmaskedarray-_drop_none:

.. py:method:: ak.contents.UnmaskedArray._drop_none(self)



.. _ak-contents-unmaskedarray-_recursively_apply:

.. py:method:: ak.contents.UnmaskedArray._recursively_apply(self, action, depth, depth_context, lateral_context, options)



.. _ak-contents-unmaskedarray-to_packed:

.. py:method:: ak.contents.UnmaskedArray.to_packed(self, recursive=True)



.. _ak-contents-unmaskedarray-_to_list:

.. py:method:: ak.contents.UnmaskedArray._to_list(self, behavior, json_conversions)



.. _ak-contents-unmaskedarray-_to_backend:

.. py:method:: ak.contents.UnmaskedArray._to_backend(self, backend)



.. _ak-contents-unmaskedarray-_is_equal_to:

.. py:method:: ak.contents.UnmaskedArray._is_equal_to(self, other, index_dtype, numpyarray, all_parameters)