NamedArray
==========

.. currentmodule:: penzai.core.named_axes

.. autoclass:: NamedArray
  :members:
  :special-members:
  :show-inheritance:


  
  
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    

  
  .. rubric:: Inherited Attributes
  .. autosummary::
  
    
    ~NamedArray.T
    
    
    ~NamedArray.at
    
    
    
    ~NamedArray.imag
    
    
    ~NamedArray.mT
    
    
    
    
    ~NamedArray.real
    
    
    
  

  
  
  
  
  
  
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    

  
  .. rubric:: Methods
  .. autosummary::
  
    
    ~NamedArray.__init__
    
    
    
    
    
    
    
    
    ~NamedArray.as_namedarrayview
    
    
    
    
    
    
    
    ~NamedArray.check_valid
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    ~NamedArray.tag
    
    
    
    
    
    
    
    
    
    
    ~NamedArray.untag
    
    
    
    ~NamedArray.unwrap
    
    
    
    
    ~NamedArray.with_positional_prefix
    
    
    ~NamedArray.wrap
    
  

  
  .. rubric:: Attributes
  .. autosummary::
  
    ~NamedArray.T
    ~NamedArray.at
    ~NamedArray.dtype
    ~NamedArray.imag
    ~NamedArray.mT
    ~NamedArray.named_shape
    ~NamedArray.positional_shape
    ~NamedArray.real
    ~NamedArray.named_axes
    ~NamedArray.data_array
  

  

  .. rubric:: Inherited Methods
  .. raw:: html

    <details style="margin-bottom: 1.5rem">
      <summary style="font-style:italic">(expand to view inherited methods)</summary>

  .. autosummary::
  
    
    
    ~NamedArray.all
    
    
    ~NamedArray.any
    
    
    ~NamedArray.argmax
    
    
    ~NamedArray.argmin
    
    
    ~NamedArray.argpartition
    
    
    ~NamedArray.argsort
    
    
    
    ~NamedArray.astype
    
    
    ~NamedArray.attributes_dict
    
    
    ~NamedArray.broadcast_like
    
    
    ~NamedArray.broadcast_to
    
    
    ~NamedArray.canonicalize
    
    
    
    ~NamedArray.choose
    
    
    ~NamedArray.clip
    
    
    ~NamedArray.compress
    
    
    ~NamedArray.conj
    
    
    ~NamedArray.conjugate
    
    
    ~NamedArray.cumprod
    
    
    ~NamedArray.cumsum
    
    
    ~NamedArray.diagonal
    
    
    ~NamedArray.dot
    
    
    ~NamedArray.flatten
    
    
    ~NamedArray.from_attributes
    
    
    ~NamedArray.item
    
    
    ~NamedArray.key_for_field
    
    
    ~NamedArray.max
    
    
    ~NamedArray.mean
    
    
    ~NamedArray.min
    
    
    ~NamedArray.nonzero
    
    
    ~NamedArray.order_as
    
    
    ~NamedArray.order_like
    
    
    ~NamedArray.prod
    
    
    ~NamedArray.ptp
    
    
    ~NamedArray.ravel
    
    
    ~NamedArray.repeat
    
    
    ~NamedArray.reshape
    
    
    ~NamedArray.round
    
    
    ~NamedArray.searchsorted
    
    
    ~NamedArray.select
    
    
    ~NamedArray.sort
    
    
    ~NamedArray.squeeze
    
    
    ~NamedArray.std
    
    
    ~NamedArray.sum
    
    
    ~NamedArray.swapaxes
    
    
    
    ~NamedArray.tag_prefix
    
    
    ~NamedArray.take
    
    
    ~NamedArray.trace
    
    
    ~NamedArray.transpose
    
    
    ~NamedArray.tree_flatten
    
    
    ~NamedArray.tree_flatten_with_keys
    
    
    ~NamedArray.tree_unflatten
    
    
    ~NamedArray.treescope_color
    
    
    
    ~NamedArray.untag_prefix
    
    
    
    ~NamedArray.var
    
    
    ~NamedArray.view
    
    
    

  .. raw:: html

    </details>