src.pydasa.elements.specs.symbolic
==================================

.. py:module:: src.pydasa.elements.specs.symbolic

.. autoapi-nested-parse::

   Module symbolic.py
   ===========================================

   Symbolic perspective for variable representation.

   This module defines the SymbolicSpecs class representing the mathematical
   and notational properties of a variable.

   Classes:
       **SymbolicSpecs**: Symbolic variable specifications

   *IMPORTANT:* Based on the theory from:

       # H.Gorter, *Dimensionalanalyse: Eine Theoririe der physikalischen Dimensionen mit Anwendungen*



Classes
-------

.. autoapisummary::

   src.pydasa.elements.specs.symbolic.SymbolicSpecs


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

.. py:class:: SymbolicSpecs

   Symbolic perspective: mathematical representation. Answers the question: "How do we WRITE this variable?"

   This perspective focuses on:
       - Symbol notation (LaTeX, Python alias)
       - Dimensional formulas (L, M, T, etc.)
       - Unit systems (original and standardized)
       - Matrix representation for linear algebra
       - Integration with symbolic math libraries

   .. attribute:: # From SymbolicSpecs

      _dims (str): Dimensional expression (e.g., "L*T^-1").
      _units (str): Units of measure (e.g., "m/s").
      _std_dims (Optional[str]): Standardized dimensional expression. e.g.: from [T^2*L^-1] to [L^(-1)*T^(2)].
      _sym_exp (Optional[str]): Sympy-compatible dimensional expression. e.g.: from [T^2*L^-1] to [T**2*L**(-1)].
      _dim_col (List[int]): Dimensional column for matrix operations. e.g.: from [T^2*L^-1] to [2, -1].
      _std_units (str): Standardized units of measure. e.g `km/h` -> `m/s`, `kByte/s` -> `bit/s`.


   .. py:property:: dims
      :type: str


      *dims* Get the dimensional expression.

      :returns: Dimensions. e.g.: [T^2*L^-1]
      :rtype: str


   .. py:property:: units
      :type: str


      *units* Get the units of measure.

      :returns: Units of measure. e.g.: `m/s`, `kg/m3`, etc.
      :rtype: str


   .. py:property:: sym_exp
      :type: Optional[str]


      *sym_exp* Get Sympy-compatible expression.

      :returns: Sympy expression. e.g.: [T**2*L**(-1)]
      :rtype: Optional[str]


   .. py:property:: dim_col
      :type: Optional[List[int]]


      *dim_col* Get dimensional column.

      :returns: Dimensional exponents. e.g.: [2, -1]
      :rtype: Optional[List[int]]


   .. py:property:: std_dims
      :type: Optional[str]


      *std_dims* Get the standardized dimensional expression.

      :returns: Standardized dimensional expression. e.g.: [L^(-1)*T^(2)]
      :rtype: Optional[str]


   .. py:property:: std_units
      :type: Optional[str]


      *std_units* Get the standardized Unit of Measure.

      :returns: standardized Unit of Measure.
      :rtype: Optional[str]


   .. py:method:: clear()

      *clear()* Reset symbolic attributes to default values.

      Resets dimensions, units, and all processed dimensional attributes.