str2d.Str2D
===========

.. currentmodule:: str2d

.. autoclass:: Str2D

   .. rubric:: operations
   .. autosummary::
      :toctree: generated/
   
      ~Str2D.add
      ~Str2D.__add__
      ~Str2D.__radd__
      ~Str2D.div
      ~Str2D.__truediv__
      ~Str2D.__rtruediv__
      ~Str2D.__mul__
      ~Str2D.__rmul__

   .. rubric:: Construction
   .. autosummary::
      :toctree: generated/
   
      ~Str2D.__init__
      ~Str2D.validate_fill
      ~Str2D.validate_halign
      ~Str2D.validate_valign
      ~Str2D.struct_array_from_bool_array
      ~Str2D.struct_array_from_char_array
      ~Str2D.struct_array_from_string
      ~Str2D.parse

   .. rubric:: Class Methods
   .. autosummary::
      :toctree: generated/

      ~Str2D.struct_pad
      ~Str2D.join_h
      ~Str2D.join_v
      ~Str2D.equal_height
      ~Str2D.equal_width
      ~Str2D.equal_shape

   .. rubric:: Information/Documentation
   .. autosummary::
      :toctree: generated/

      ~Str2D.show_with_alignment
      ~Str2D.transormation_palette
      ~Str2D.pre

   .. rubric:: Special Dunder Methods
   .. autosummary::
      :toctree: generated/

      ~Str2D.__getattr__
      ~Str2D.__getitem__

   .. rubric:: Methods
   .. autosummary::
      :toctree: generated/
   
      ~Str2D.box
      ~Str2D.box_around
      ~Str2D.box_over
      ~Str2D.circle
      ~Str2D.hole
      ~Str2D.expand
      ~Str2D.pad
      ~Str2D.split
      ~Str2D.insert
      ~Str2D.reshape
      ~Str2D.roll
      ~Str2D.roll_h
      ~Str2D.roll_v
      ~Str2D.hide
      ~Str2D.fill_with

   .. rubric:: String Methods that return a new Str2D object
   .. autosummary::
      :toctree: generated/

      ~Str2D.lower
      ~Str2D.lstrip
      ~Str2D.replace
      ~Str2D.rstrip
      ~Str2D.strip
      ~Str2D.strip2d
      ~Str2D.title
      ~Str2D.upper

   .. rubric:: String Methods that return a boolean array
   .. autosummary::
      :toctree: generated/

      ~Str2D.isdigit

   .. rubric:: Transformations
   .. autosummary::
      :toctree: generated/
   
      ~Str2D.i
      ~Str2D.t
      ~Str2D.h
      ~Str2D.v
      ~Str2D.r

   .. rubric:: Attributes
   .. autosummary::
      :toctree: generated/
   
      ~Str2D.alpha
      ~Str2D.char
      ~Str2D.height
      ~Str2D.width
      ~Str2D.shape
      ~Str2D.kwargs
   
   .. rubric:: Fun Methods
   .. autosummary::
      :toctree: generated/

      ~Str2D.pi
      ~Str2D.e
      ~Str2D.phi