
    tKg1              
          d Z ddlZddlmZ ddlmZ g dZ G d de	      Z
 G d	 d
e	      Z G d de      Zdddddddddd	Z ej                  e      Z	 d Zd ZdddZeZd Zd$dZ G d d      Z G d  d!      Zd" Zd# Zy)%zf
Base classes for MATLAB file stream reading.

MATLAB is a registered trademark of the Mathworks inc.
    N)doccer   )_byteordercodes)MatReadErrorMatReadWarningMatWriteErrorc                       e Zd ZdZy)r   z"Exception indicating a read issue.N__name__
__module____qualname____doc__     \/home/alanp/www/video.onchill/myenv/lib/python3.12/site-packages/scipy/io/matlab/_miobase.pyr   r      s    ,r   r   c                       e Zd ZdZy)r   z#Exception indicating a write issue.Nr
   r   r   r   r   r      s    -r   r   c                       e Zd ZdZy)r   zWarning class for read issues.Nr
   r   r   r   r   r      s    (r   r   zfile_name : str
   Name of the mat file (do not need .mat extension if
   appendmat==True) Can also pass open file-like object.zappendmat : bool, optional
   True to append the .mat extension to the end of the given
   filename, if not already present. Default is True.a  byte_order : str or None, optional
   None by default, implying byte order guessed from mat
   file. Otherwise can be one of ('native', '=', 'little', '<',
   'BIG', '>').
mat_dtype : bool, optional
   If True, return arrays in same dtype as would be loaded into
   MATLAB (instead of the dtype with which they are saved).
squeeze_me : bool, optional
   Whether to squeeze unit matrix dimensions or not.
chars_as_strings : bool, optional
   Whether to convert char arrays to string arrays.
matlab_compatible : bool, optional
   Returns matrices as would be loaded by MATLAB (implies
   squeeze_me=False, chars_as_strings=False, mat_dtype=True,
   struct_as_record=True).ab  struct_as_record : bool, optional
   Whether to load MATLAB structs as NumPy record arrays, or as
   old-style NumPy arrays with dtype=object. Setting this flag to
   False replicates the behavior of SciPy version 0.7.x (returning
   numpy object arrays). The default setting is True, because it
   allows easier round-trip load and save of MATLAB files.zAmat_stream : file-like
   Object with file API, open for reading.a  long_field_names : bool, optional
   * False - maximum field name length in a structure is 31 characters
     which is the documented maximum length. This is the default.
   * True - maximum field name length in a structure is 63 characters
     which works for MATLAB 7.6z[do_compression : bool, optional
   Whether to compress matrices on write. Default is False.zoned_as : {'row', 'column'}, optional
   If 'column', write 1-D NumPy arrays as column vectors.
   If 'row', write 1D NumPy arrays as row vectors.zbunicode_strings : bool, optional
   If True, write strings as Unicode, else MATLAB usual encoding.)	file_arg
append_arg	load_args
struct_argmatstream_arglong_fieldsdo_compressiononed_asunicode_stringsc                     | j                         }|D ],  }t        j                  ||         j                  |      ||<   . |S )a   Convert dtypes in mapping to given order

    Parameters
    ----------
    dtype_template : mapping
       mapping with values returning numpy dtype from ``np.dtype(val)``
    order_code : str
       an order code suitable for using in ``dtype.newbyteorder()``

    Returns
    -------
    dtypes : mapping
       mapping where values have been replaced by
       ``np.dtype(val).newbyteorder(order_code)``

    )copynpdtypenewbyteorder)dtype_template
order_codedtypesks       r   convert_dtypesr&      sB    "   "FHHVAY'44Z@q	 Mr   c                 n    |j                   }t        j                  d|| j                  |      d      }|S )af  
    Generic get of byte stream data of known type

    Parameters
    ----------
    mat_stream : file_like object
        MATLAB (tm) mat file stream
    a_dtype : dtype
        dtype of array to read. `a_dtype` is assumed to be correct
        endianness.

    Returns
    -------
    arr : ndarray
        Array of dtype `a_dtype` read from stream.

    r   F)shaper    bufferorder)itemsizer   ndarrayread)
mat_streama_dtype	num_bytesarrs       r   
read_dtyper3      s8    $   I
**2"&OOI6 C Jr   T	appendmatc                d    ddl m}  || |      5 }t        |      cddd       S # 1 sw Y   yxY w)a  
    Return major, minor tuple depending on apparent mat file type

    Where:

     #. 0,x -> version 4 format mat files
     #. 1,x -> version 5 format mat files
     #. 2,x -> version 7.3 format mat files (HDF format)

    Parameters
    ----------
    file_name : str
       Name of the mat file (do not need .mat extension if
       appendmat==True). Can also pass open file-like object.
    appendmat : bool, optional
       True to append the .mat extension to the end of the given
       filename, if not already present. Default is True.

    Returns
    -------
    major_version : {0, 1, 2}
        major MATLAB File format version
    minor_version : int
        minor MATLAB file format version

    Raises
    ------
    MatReadError
        If the file is empty.
    ValueError
        The matfile version is unknown.

    Notes
    -----
    Has the side effect of setting the file read pointer to 0
    r   )_open_file_contextr4   N)_mior7   _get_matfile_version)	file_namer5   r7   fileobjs       r   matfile_versionr<      s(    J )	I	;w#G, 
<	;	;s   &/c                    | j                  d       | j                  d      }t        |      dk(  rt        d      t	        j
                  dt        j                  |      }d|v r| j                  d       y| j                  d       | j                  d      }| j                  d       t        |d   d	k(        }t        ||         }t        |d
|z
           }||f}|dv r|S t         dj                  |       )Nr      zMat file appears to be empty)r>   r)   r    r*   r   r   |      I   r   )r   rB   z%Unknown mat file type, version {}, {})
seekr.   lenr   r   r-   uint8int
ValueErrorformat)r;   
mopt_bytes	mopt_intstst_strmaj_indmaj_valmin_valrets           r   r9   r9      s    LLOaJ
:!9::

RXXjIII~Q LLll1oGLLO'!*'(G''"#G'!g+&'GG
C&

C<CCSI
JJr   c                     | j                   }|dk(  ryt        |      dk(  r+|d   dk(  ry|dk(  r|dz   S |dk(  rd|z   S t        d	|z        |S )
a  
    Determine equivalent MATLAB dimensions for given array

    Parameters
    ----------
    arr : ndarray
        Input array
    oned_as : {'column', 'row'}, optional
        Whether 1-D arrays are returned as MATLAB row or column matrices.
        Default is 'column'.

    Returns
    -------
    dims : tuple
        Shape tuple, in the form MATLAB expects it.

    Notes
    -----
    We had to decide what shape a 1 dimensional array would be by
    default. ``np.atleast_2d`` thinks it is a row vector. The
    default for a vector in MATLAB (e.g., ``>> 1:12``) is a row vector.

    Versions of scipy up to and including 0.11 resulted (accidentally)
    in 1-D arrays being read as column vectors. For the moment, we
    maintain the same tradition here.

    Examples
    --------
    >>> import numpy as np
    >>> from scipy.io.matlab._miobase import matdims
    >>> matdims(np.array(1)) # NumPy scalar
    (1, 1)
    >>> matdims(np.array([1])) # 1-D array, 1 element
    (1, 1)
    >>> matdims(np.array([1,2])) # 1-D array, 2 elements
    (2, 1)
    >>> matdims(np.array([[2],[3]])) # 2-D array, column vector
    (2, 1)
    >>> matdims(np.array([[2,3]])) # 2-D array, row vector
    (1, 2)
    >>> matdims(np.array([[[2,3]]])) # 3-D array, rowish vector
    (1, 1, 2)
    >>> matdims(np.array([])) # empty 1-D array
    (0, 0)
    >>> matdims(np.array([[]])) # empty 2-D array
    (0, 0)
    >>> matdims(np.array([[[]]])) # empty 3-D array
    (0, 0, 0)

    Optional argument flips 1-D shape behavior.

    >>> matdims(np.array([1,2]), 'row') # 1-D array, 2 elements
    (1, 2)

    The argument has to make sense though

    >>> matdims(np.array([1,2]), 'bizarre')
    Traceback (most recent call last):
       ...
    ValueError: 1-D option "bizarre" is strange

    r   )r   r   r   r   r@   column)r   rowz1-D option "%s" is strange)r)   rE   rH   )r2   r   r)   s      r   matdimsrT      sr    ~ IIE{
5zQ8q= 4<%<9&' ( (Lr   c                   "    e Zd ZdZd Zd Zd Zy)MatVarReaderz; Abstract class defining required interface for var readersc                      y )Nr   )selffile_readers     r   __init__zMatVarReader.__init__I  s    r   c                      y)z Returns header Nr   rX   s    r   read_headerzMatVarReader.read_headerL      r   c                      y)z Reads array given header Nr   )rX   headers     r   array_from_headerzMatVarReader.array_from_headerP  r^   r   N)r   r   r   r   rZ   r]   ra   r   r   r   rV   rV   G  s    Er   rV   c                   D    e Zd ZdZe	 	 	 	 	 	 	 	 dd       Zd Zd Zd Zy)MatFileReadera   Base object for reading mat files

    To make this class functional, you will need to override the
    following methods:

    matrix_getter_factory   - gives object to fetch next matrix from stream
    guess_byte_order        - guesses file byte order from file
    Nc
                    || _         i | _        |s| j                         }nt        j                  |      }|| _        || _        |r| j                          n|| _        || _	        || _
        || _        |	| _        |	rd| _        d| _        yy)z
        Initializer for mat file reader

        mat_stream : file-like
            object with file API, open for reading
    %(load_args)s
        TFN)r/   r$   guess_byte_orderbocto_numpy_code
byte_orderstruct_as_recordset_matlab_compatible
squeeze_mechars_as_strings	mat_dtype verify_compressed_data_integritysimplify_cells)
rX   r/   rh   rm   rk   rl   matlab_compatibleri   rn   ro   s
             r   rZ   zMatFileReader.__init___  s    $ %..0J**:6J$ 0&&((DO$4D!&DN0P-,"DO$)D! r   c                 .    d| _         d| _        d| _        y)z4 Sets options to return arrays as MATLAB loads them TFN)rm   rk   rl   r\   s    r   rj   z#MatFileReader.set_matlab_compatible  s     %r   c                 "    t         j                  S )z9 As we do not know what file type we have, assume native )rf   native_coder\   s    r   re   zMatFileReader.guess_byte_order  s    r   c                     | j                   j                  d      }| j                   j                         }| j                   j                  |dz
         t	        |      dk(  S )Nr   r   )r/   r.   tellrD   rE   )rX   bcurposs      r   end_of_streamzMatFileReader.end_of_stream  sL    OO  #%%'VAX&1v{r   )NFFTFTTF)	r   r   r   r   	docfillerrZ   rj   re   rx   r   r   r   rc   rc   U  sC       !"&#("&26 %#* #*J&r   rc   c                 r    t        j                  | j                  j                  dd t        |      z         S )z3 Return dtype for given number of items per elementNrB   )r   r    str)r2   nums     r   arr_dtype_numberr}     s)    88CIIMM"1%C011r   c                    t        | j                        }|sdg}|j                  t        | j                  j
                  dd              t        j                  |t        | d      |       } | t        j                  d| j                        k(  g}t        j                  |      s| S | j                         } d| t        |      <   | S )z$ Convert string array to char array r   rB   Nr?    )r     )listr)   appendrG   r    r{   r   r-   r}   arrayanyr   tuple)r2   dimsemptiess      r   arr_to_charsr     s    		?DsKKCIIMM!"%&'
**4+C3!C bhhr334G66'?

((*CCgJr   )rR   )r   numpyr   
scipy._libr   r   r   rf   __all__	Exceptionr   r   UserWarningr   doc_dictfilldocry   r&   r3   r<   get_matfile_versionr9   rT   rV   rc   r}   r   r   r   r   <module>r      s      $-9 -.I .)[ )
<
9
 
>
.
#
?
6
Ea1F 	h FNN8$	*Z.4 -1 '-T & K2L^ > >B2
r   