plesty.lib.data.table
=====================

.. py:module:: plesty.lib.data.table

.. autoapi-nested-parse::

   This module defines the PlestyTable class, which represents a tabular data structure
   with named columns and rows. It provides methods for accessing and manipulating the data
   in a structured way.



Classes
-------

.. autoapisummary::

   plesty.lib.data.table.TableHeader
   plesty.lib.data.table.PlestyTable2D
   plesty.lib.data.table.PlestyTable3D


Module Contents
---------------

.. py:class:: TableHeader

   Represents the header of a PlestyTable, defining column names and types.


   .. py:attribute:: name
      :type:  str


   .. py:attribute:: dtype
      :type:  Any
      :value: None



   .. py:attribute:: unit
      :type:  str | None
      :value: None



   .. py:attribute:: description
      :type:  str | None
      :value: None



.. py:class:: PlestyTable2D

   A simple 2D table structure that holds a list of 1d PlestyArrays,
   each representing a row/column of the table.


   .. py:attribute:: name
      :type:  str


   .. py:attribute:: data
      :type:  list[plesty.lib.data.array.PlestyArray]


   .. py:attribute:: header
      :type:  list[TableHeader] | None
      :value: None



   .. py:attribute:: description
      :type:  str | None
      :value: None



.. py:class:: PlestyTable3D

   A simple 3D table structure that holds a list of 2d PlestyTables,
   each representing a layer of the table.


   .. py:attribute:: name
      :type:  str


   .. py:attribute:: shape
      :type:  tuple[int, int]


   .. py:attribute:: data
      :type:  list[list[plesty.lib.data.array.PlestyArray]]


   .. py:attribute:: rheader
      :type:  list[TableHeader] | None
      :value: None



   .. py:attribute:: cheader
      :type:  list[TableHeader] | None
      :value: None



   .. py:attribute:: description
      :type:  str | None
      :value: None



   .. py:method:: get_item_at(row: int, col: int) -> plesty.lib.data.array.PlestyArray

      Get the item at the specified row and column.