U
    »mœdˆ°  ã                   @   sâ  d Z ddlm  mZ ddlZedƒZdd„ Z	dd„ Z
dd	„ Zd
d„ Zdd„ Zdd„ Zdd„ Zdd„ Zdd„ Zdd„ Zdd„ Zdd„ Zdd„ Zdd„ Zdqd!d"„Zdrd#d$„Zd%d&„ Zd'd(„ Zd)d*„ Zd+d,„ Zd-d.„ Zd/d0„ Zd1d2„ Zd3d4„ Z d5d6„ Z!d7d8„ Z"d9d:„ Z#d;d<„ Z$d=d>„ Z%d?d@„ Z&dAdB„ Z'dCdD„ Z(dEdF„ Z)dGdH„ Z*dIdJ„ Z+dKdL„ Z,dMdN„ Z-dOdP„ Z.dQdR„ Z/dsdSdT„Z0dtdUdV„Z1dWdX„ Z2dYdZ„ Z3d[d\„ Z4d]d^„ Z5d_d`„ Z6dadb„ Z7dcdd„ Z8dedf„ Z9dgdh„ Z:didj„ Z;dkdl„ Z<dmdn„ Z=dodp„ Z>dS )uz0
Direct wrappers for Fortran `id_dist` backend.
é    Nznonzero return codec                 C   s.   t  | ¡} | jjr | jdd�} n
t  | ¡} | S )z6
    Same as np.asfortranarray, but ensure a copy
    ÚF©Úorder)ÚnpZasarrayÚflagsÚf_contiguousÚcopyÚasfortranarray)ÚA© r   ú\/home/sam/Atlas/atlas_env/lib/python3.8/site-packages/scipy/linalg/_interpolative_backend.pyÚ_asfortranarray_copy(   s
    

r   c                 C   s
   t  | ¡S )a  
    Generate standard uniform pseudorandom numbers via a very efficient lagged
    Fibonacci method.

    :param n:
        Number of pseudorandom numbers to generate.
    :type n: int

    :return:
        Pseudorandom numbers.
    :rtype: :class:`numpy.ndarray`
    )Ú_idÚid_srand)Únr   r   r   r   8   s    r   c                 C   s   t  | ¡} t | ¡ dS )z¹
    Initialize seed values for :func:`id_srand` (any appropriately random
    numbers will do).

    :param t:
        Array of 55 seed values.
    :type t: :class:`numpy.ndarray`
    N)r   r	   r   Ú	id_srandi)Útr   r   r   r   H   s    	
r   c                   C   s   t  ¡  dS )z5
    Reset seed values to their original values.
    N)r   Ú	id_srandor   r   r   r   r   U   s    r   c                 C   s   t  | ||¡S )a|  
    Transform real vector via a composition of Rokhlin's random transform,
    random subselection, and an FFT.

    In contrast to :func:`idd_sfrm`, this routine works best when the length of
    the transformed vector is the power-of-two integer output by
    :func:`idd_frmi`, or when the length is not specified but instead
    determined a posteriori from the output. The returned transformed vector is
    randomly permuted.

    :param n:
        Greatest power-of-two integer satisfying `n <= x.size` as obtained from
        :func:`idd_frmi`; `n` is also the length of the output vector.
    :type n: int
    :param w:
        Initialization array constructed by :func:`idd_frmi`.
    :type w: :class:`numpy.ndarray`
    :param x:
        Vector to be transformed.
    :type x: :class:`numpy.ndarray`

    :return:
        Transformed vector.
    :rtype: :class:`numpy.ndarray`
    )r   Úidd_frm©r   ÚwÚxr   r   r   r   `   s    r   c                 C   s   t  | |||¡S )aê  
    Transform real vector via a composition of Rokhlin's random transform,
    random subselection, and an FFT.

    In contrast to :func:`idd_frm`, this routine works best when the length of
    the transformed vector is known a priori.

    :param l:
        Length of transformed vector, satisfying `l <= n`.
    :type l: int
    :param n:
        Greatest power-of-two integer satisfying `n <= x.size` as obtained from
        :func:`idd_sfrmi`.
    :type n: int
    :param w:
        Initialization array constructed by :func:`idd_sfrmi`.
    :type w: :class:`numpy.ndarray`
    :param x:
        Vector to be transformed.
    :type x: :class:`numpy.ndarray`

    :return:
        Transformed vector.
    :rtype: :class:`numpy.ndarray`
    )r   Úidd_sfrm©Úlr   r   r   r   r   r   r   }   s    r   c                 C   s
   t  | ¡S )aC  
    Initialize data for :func:`idd_frm`.

    :param m:
        Length of vector to be transformed.
    :type m: int

    :return:
        Greatest power-of-two integer `n` satisfying `n <= m`.
    :rtype: int
    :return:
        Initialization array to be used by :func:`idd_frm`.
    :rtype: :class:`numpy.ndarray`
    )r   Úidd_frmi©Úmr   r   r   r   š   s    r   c                 C   s   t  | |¡S )a•  
    Initialize data for :func:`idd_sfrm`.

    :param l:
        Length of output transformed vector.
    :type l: int
    :param m:
        Length of the vector to be transformed.
    :type m: int

    :return:
        Greatest power-of-two integer `n` satisfying `n <= m`.
    :rtype: int
    :return:
        Initialization array to be used by :func:`idd_sfrm`.
    :rtype: :class:`numpy.ndarray`
    )r   Ú	idd_sfrmi©r   r   r   r   r   r   ¬   s    r   c                 C   sZ   t |ƒ}t | |¡\}}}|jd }|j ¡ d|||  … j||| fdd�}|||fS )až  
    Compute ID of a real matrix to a specified relative precision.

    :param eps:
        Relative precision.
    :type eps: float
    :param A:
        Matrix.
    :type A: :class:`numpy.ndarray`

    :return:
        Rank of ID.
    :rtype: int
    :return:
        Column index array.
    :rtype: :class:`numpy.ndarray`
    :return:
        Interpolation coefficients.
    :rtype: :class:`numpy.ndarray`
    é   Nr   r   )r   r   Úiddp_idÚshapeÚTÚravelÚreshape©Úepsr
   ÚkÚidxÚrnormsr   Úprojr   r   r   r!   Å   s
    
,r!   c                 C   sV   t | ƒ} t | |¡\}}| jd }| j ¡ d|||  … j||| fdd�}||fS )aQ  
    Compute ID of a real matrix to a specified rank.

    :param A:
        Matrix.
    :type A: :class:`numpy.ndarray`
    :param k:
        Rank of ID.
    :type k: int

    :return:
        Column index array.
    :rtype: :class:`numpy.ndarray`
    :return:
        Interpolation coefficients.
    :rtype: :class:`numpy.ndarray`
    r    Nr   r   )r   r   Úiddr_idr"   r#   r$   r%   ©r
   r(   r)   r*   r   r+   r   r   r   r,   á   s
    
,r,   c                 C   s<   t  | ¡} |jdkr"t | ||¡S | dd…t  |¡f S dS )as  
    Reconstruct matrix from real ID.

    :param B:
        Skeleton matrix.
    :type B: :class:`numpy.ndarray`
    :param idx:
        Column index array.
    :type idx: :class:`numpy.ndarray`
    :param proj:
        Interpolation coefficients.
    :type proj: :class:`numpy.ndarray`

    :return:
        Reconstructed matrix.
    :rtype: :class:`numpy.ndarray`
    r   N)r   r	   Úsizer   Úidd_reconidÚargsort©ÚBr)   r+   r   r   r   r/   ú   s    

r/   c                 C   s   t  | |¡S )a6  
    Reconstruct interpolation matrix from real ID.

    :param idx:
        Column index array.
    :type idx: :class:`numpy.ndarray`
    :param proj:
        Interpolation coefficients.
    :type proj: :class:`numpy.ndarray`

    :return:
        Interpolation matrix.
    :rtype: :class:`numpy.ndarray`
    )r   Úidd_reconint©r)   r+   r   r   r   r3     s    r3   c                 C   s   t  | ¡} t | ||¡S )aN  
    Reconstruct skeleton matrix from real ID.

    :param A:
        Original matrix.
    :type A: :class:`numpy.ndarray`
    :param k:
        Rank of ID.
    :type k: int
    :param idx:
        Column index array.
    :type idx: :class:`numpy.ndarray`

    :return:
        Skeleton matrix.
    :rtype: :class:`numpy.ndarray`
    )r   r	   r   Úidd_copycols©r
   r(   r)   r   r   r   r5   %  s    
r5   c                 C   s2   t  | ¡} t | ||¡\}}}}|r(t‚|||fS )a  
    Convert real ID to SVD.

    :param B:
        Skeleton matrix.
    :type B: :class:`numpy.ndarray`
    :param idx:
        Column index array.
    :type idx: :class:`numpy.ndarray`
    :param proj:
        Interpolation coefficients.
    :type proj: :class:`numpy.ndarray`

    :return:
        Left singular vectors.
    :rtype: :class:`numpy.ndarray`
    :return:
        Right singular vectors.
    :rtype: :class:`numpy.ndarray`
    :return:
        Singular values.
    :rtype: :class:`numpy.ndarray`
    )r   r	   r   Ú
idd_id2svdÚ_RETCODE_ERROR©r2   r)   r+   ÚUÚVÚSÚierr   r   r   r7   ?  s
    
r7   é   c                 C   s   t  | ||||¡\}}|S )a  
    Estimate spectral norm of a real matrix by the randomized power method.

    :param m:
        Matrix row dimension.
    :type m: int
    :param n:
        Matrix column dimension.
    :type n: int
    :param matvect:
        Function to apply the matrix transpose to a vector, with call signature
        `y = matvect(x)`, where `x` and `y` are the input and output vectors,
        respectively.
    :type matvect: function
    :param matvec:
        Function to apply the matrix to a vector, with call signature
        `y = matvec(x)`, where `x` and `y` are the input and output vectors,
        respectively.
    :type matvec: function
    :param its:
        Number of power method iterations.
    :type its: int

    :return:
        Spectral norm estimate.
    :rtype: float
    )r   Ú	idd_snorm)r   r   ÚmatvectÚmatvecÚitsÚsnormÚvr   r   r   r?   b  s    r?   c              	   C   s   t  | ||||||¡S )a0  
    Estimate spectral norm of the difference of two real matrices by the
    randomized power method.

    :param m:
        Matrix row dimension.
    :type m: int
    :param n:
        Matrix column dimension.
    :type n: int
    :param matvect:
        Function to apply the transpose of the first matrix to a vector, with
        call signature `y = matvect(x)`, where `x` and `y` are the input and
        output vectors, respectively.
    :type matvect: function
    :param matvect2:
        Function to apply the transpose of the second matrix to a vector, with
        call signature `y = matvect2(x)`, where `x` and `y` are the input and
        output vectors, respectively.
    :type matvect2: function
    :param matvec:
        Function to apply the first matrix to a vector, with call signature
        `y = matvec(x)`, where `x` and `y` are the input and output vectors,
        respectively.
    :type matvec: function
    :param matvec2:
        Function to apply the second matrix to a vector, with call signature
        `y = matvec2(x)`, where `x` and `y` are the input and output vectors,
        respectively.
    :type matvec2: function
    :param its:
        Number of power method iterations.
    :type its: int

    :return:
        Spectral norm estimate of matrix difference.
    :rtype: float
    )r   Úidd_diffsnorm)r   r   r@   Zmatvect2rA   Úmatvec2rB   r   r   r   rE   ‚  s    'rE   c                 C   s0   t  | ¡} t | |¡\}}}}|r&t‚|||fS )a›  
    Compute SVD of a real matrix to a specified rank.

    :param A:
        Matrix.
    :type A: :class:`numpy.ndarray`
    :param k:
        Rank of SVD.
    :type k: int

    :return:
        Left singular vectors.
    :rtype: :class:`numpy.ndarray`
    :return:
        Right singular vectors.
    :rtype: :class:`numpy.ndarray`
    :return:
        Singular values.
    :rtype: :class:`numpy.ndarray`
    )r   r	   r   Úiddr_svdr8   ©r
   r(   r:   r;   r<   r=   r   r   r   rG   °  s
    
rG   c                 C   sª   t  |¡}|j\}}t | |¡\}}}}}}	|	r4t‚||d |||  d … j||fdd�}
||d |||  d … j||fdd�}||d || d … }|
||fS )a¶  
    Compute SVD of a real matrix to a specified relative precision.

    :param eps:
        Relative precision.
    :type eps: float
    :param A:
        Matrix.
    :type A: :class:`numpy.ndarray`

    :return:
        Left singular vectors.
    :rtype: :class:`numpy.ndarray`
    :return:
        Right singular vectors.
    :rtype: :class:`numpy.ndarray`
    :return:
        Singular values.
    :rtype: :class:`numpy.ndarray`
    r    r   r   )r   r	   r"   r   Úiddp_svdr8   r%   ©r'   r
   r   r   r(   ÚiUÚiVÚiSr   r=   r:   r;   r<   r   r   r   rI   Ì  s    

**rI   c           	      C   sˆ   t  |¡}|j\}}t|ƒ\}}t j|d| d  | d dd�}t | |||¡\}}}|d|||  … j||| fdd�}|||fS )a¸  
    Compute ID of a real matrix to a specified relative precision using random
    sampling.

    :param eps:
        Relative precision.
    :type eps: float
    :param A:
        Matrix.
    :type A: :class:`numpy.ndarray`

    :return:
        Rank of ID.
    :rtype: int
    :return:
        Column index array.
    :rtype: :class:`numpy.ndarray`
    :return:
        Interpolation coefficients.
    :rtype: :class:`numpy.ndarray`
    é   r    r   r   N)r   r	   r"   r   Úemptyr   Úiddp_aidr%   ©	r'   r
   r   r   Ún2r   r+   r(   r)   r   r   r   rP   ð  s    

"&rP   c                 C   sZ   t  |¡}|j\}}t|ƒ\}}t j|| |d |d   dd�}t | |||¡\}}|S )ae  
    Estimate rank of a real matrix to a specified relative precision using
    random sampling.

    The output rank is typically about 8 higher than the actual rank.

    :param eps:
        Relative precision.
    :type eps: float
    :param A:
        Matrix.
    :type A: :class:`numpy.ndarray`

    :return:
        Rank estimate.
    :rtype: int
    r    r   r   )r   r	   r"   r   rO   r   Úidd_estrank©r'   r
   r   r   rR   r   Úrar(   r   r   r   rS     s    

"rS   c                 C   s  t  |¡}|j\}}t |¡\}}t jtt||ƒd d| d|  d  dt||ƒd   d| d |d  ƒdd�}t | |||¡\}}}	}
}}|ršt	‚||d |||  d … j
||fdd�}||	d |	||  d … j
||fdd�}||
d |
| d … }|||fS )aÐ  
    Compute SVD of a real matrix to a specified relative precision using random
    sampling.

    :param eps:
        Relative precision.
    :type eps: float
    :param A:
        Matrix.
    :type A: :class:`numpy.ndarray`

    :return:
        Left singular vectors.
    :rtype: :class:`numpy.ndarray`
    :return:
        Right singular vectors.
    :rtype: :class:`numpy.ndarray`
    :return:
        Singular values.
    :rtype: :class:`numpy.ndarray`
    r    é   é   é   rN   r   r   )r   r	   r"   r   r   rO   ÚmaxÚminÚ	iddp_asvdr8   r%   ©r'   r
   r   r   rR   Zwinitr   r(   rK   rL   rM   r=   r:   r;   r<   r   r   r   r[   -  s     

4ÿý**r[   c                 C   s~   t j|d d| t||ƒd   dd�}t | ||||¡\}}}}|dkrNt‚|d|||  … j||| fdd�}|||fS )aë  
    Compute ID of a real matrix to a specified relative precision using random
    matrix-vector multiplication.

    :param eps:
        Relative precision.
    :type eps: float
    :param m:
        Matrix row dimension.
    :type m: int
    :param n:
        Matrix column dimension.
    :type n: int
    :param matvect:
        Function to apply the matrix transpose to a vector, with call signature
        `y = matvect(x)`, where `x` and `y` are the input and output vectors,
        respectively.
    :type matvect: function

    :return:
        Rank of ID.
    :rtype: int
    :return:
        Column index array.
    :rtype: :class:`numpy.ndarray`
    :return:
        Interpolation coefficients.
    :rtype: :class:`numpy.ndarray`
    r    rN   r   r   r   N)r   rO   rZ   r   Úiddp_ridr8   r%   )r'   r   r   r@   r+   r(   r)   r=   r   r   r   r]   W  s    (&r]   c                 C   s"   t  | |||¡\}}}|rt‚|S )aQ  
    Estimate rank of a real matrix to a specified relative precision using
    random matrix-vector multiplication.

    :param eps:
        Relative precision.
    :type eps: float
    :param m:
        Matrix row dimension.
    :type m: int
    :param n:
        Matrix column dimension.
    :type n: int
    :param matvect:
        Function to apply the matrix transpose to a vector, with call signature
        `y = matvect(x)`, where `x` and `y` are the input and output vectors,
        respectively.
    :type matvect: function

    :return:
        Rank estimate.
    :rtype: int
    )r   Úidd_findrankr8   )r'   r   r   r@   r(   rU   r=   r   r   r   r^   }  s    r^   c                 C   sœ   t  | ||||¡\}}}}}	}
|
r&t‚|	|d |||  d … j||fdd�}|	|d |||  d … j||fdd�}|	|d || d … }|||fS )aÚ  
    Compute SVD of a real matrix to a specified relative precision using random
    matrix-vector multiplication.

    :param eps:
        Relative precision.
    :type eps: float
    :param m:
        Matrix row dimension.
    :type m: int
    :param n:
        Matrix column dimension.
    :type n: int
    :param matvect:
        Function to apply the matrix transpose to a vector, with call signature
        `y = matvect(x)`, where `x` and `y` are the input and output vectors,
        respectively.
    :type matvect: function
    :param matvec:
        Function to apply the matrix to a vector, with call signature
        `y = matvec(x)`, where `x` and `y` are the input and output vectors,
        respectively.
    :type matvec: function

    :return:
        Left singular vectors.
    :rtype: :class:`numpy.ndarray`
    :return:
        Right singular vectors.
    :rtype: :class:`numpy.ndarray`
    :return:
        Singular values.
    :rtype: :class:`numpy.ndarray`
    r    r   r   )r   Ú	iddp_rsvdr8   r%   )r'   r   r   r@   rA   r(   rK   rL   rM   r   r=   r:   r;   r<   r   r   r   r_   Ÿ  s    #**r_   c                 C   sr   t  | ¡} | j\}}t|||ƒ}t | ||¡\}}||krTt j||| fddd�}n|j||| fdd�}||fS )ag  
    Compute ID of a real matrix to a specified rank using random sampling.

    :param A:
        Matrix.
    :type A: :class:`numpy.ndarray`
    :param k:
        Rank of ID.
    :type k: int

    :return:
        Column index array.
    :rtype: :class:`numpy.ndarray`
    :return:
        Interpolation coefficients.
    :rtype: :class:`numpy.ndarray`
    Zfloat64r   ©Zdtyper   r   )r   r	   r"   Ú	iddr_aidir   Úiddr_aidrO   r%   ©r
   r(   r   r   r   r)   r+   r   r   r   rb   Ï  s    

rb   c                 C   s   t  | ||¡S )aO  
    Initialize array for :func:`iddr_aid`.

    :param m:
        Matrix row dimension.
    :type m: int
    :param n:
        Matrix column dimension.
    :type n: int
    :param k:
        Rank of ID.
    :type k: int

    :return:
        Initialization array to be used by :func:`iddr_aid`.
    :rtype: :class:`numpy.ndarray`
    )r   ra   ©r   r   r(   r   r   r   ra   ì  s    ra   c           
      C   s”   t  | ¡} | j\}}t jd| d | d| d |  d|d   d dd�}t|||ƒ}||d	|j…< t | ||¡\}}}}	|	d
krŠt‚|||fS )a±  
    Compute SVD of a real matrix to a specified rank using random sampling.

    :param A:
        Matrix.
    :type A: :class:`numpy.ndarray`
    :param k:
        Rank of SVD.
    :type k: int

    :return:
        Left singular vectors.
    :rtype: :class:`numpy.ndarray`
    :return:
        Right singular vectors.
    :rtype: :class:`numpy.ndarray`
    :return:
        Singular values.
    :rtype: :class:`numpy.ndarray`
    rN   é   é   é   rX   éd   r   r   Nr   )	r   r	   r"   rO   ra   r.   r   Ú	iddr_asvdr8   ©
r
   r(   r   r   r   Zw_r:   r;   r<   r=   r   r   r   ri     s    

:ri   c                 C   sB   t  | |||¡\}}|d|||  … j||| fdd�}||fS )až  
    Compute ID of a real matrix to a specified rank using random matrix-vector
    multiplication.

    :param m:
        Matrix row dimension.
    :type m: int
    :param n:
        Matrix column dimension.
    :type n: int
    :param matvect:
        Function to apply the matrix transpose to a vector, with call signature
        `y = matvect(x)`, where `x` and `y` are the input and output vectors,
        respectively.
    :type matvect: function
    :param k:
        Rank of ID.
    :type k: int

    :return:
        Column index array.
    :rtype: :class:`numpy.ndarray`
    :return:
        Interpolation coefficients.
    :rtype: :class:`numpy.ndarray`
    Nr   r   )r   Úiddr_ridr%   )r   r   r@   r(   r)   r+   r   r   r   rk   )  s    &rk   c           	      C   s0   t  | ||||¡\}}}}|dkr&t‚|||fS )a¿  
    Compute SVD of a real matrix to a specified rank using random matrix-vector
    multiplication.

    :param m:
        Matrix row dimension.
    :type m: int
    :param n:
        Matrix column dimension.
    :type n: int
    :param matvect:
        Function to apply the matrix transpose to a vector, with call signature
        `y = matvect(x)`, where `x` and `y` are the input and output vectors,
        respectively.
    :type matvect: function
    :param matvec:
        Function to apply the matrix to a vector, with call signature
        `y = matvec(x)`, where `x` and `y` are the input and output vectors,
        respectively.
    :type matvec: function
    :param k:
        Rank of SVD.
    :type k: int

    :return:
        Left singular vectors.
    :rtype: :class:`numpy.ndarray`
    :return:
        Right singular vectors.
    :rtype: :class:`numpy.ndarray`
    :return:
        Singular values.
    :rtype: :class:`numpy.ndarray`
    r   )r   Ú	iddr_rsvdr8   )	r   r   r@   rA   r(   r:   r;   r<   r=   r   r   r   rl   M  s    #rl   c                 C   s   t  | ||¡S )a  
    Transform complex vector via a composition of Rokhlin's random transform,
    random subselection, and an FFT.

    In contrast to :func:`idz_sfrm`, this routine works best when the length of
    the transformed vector is the power-of-two integer output by
    :func:`idz_frmi`, or when the length is not specified but instead
    determined a posteriori from the output. The returned transformed vector is
    randomly permuted.

    :param n:
        Greatest power-of-two integer satisfying `n <= x.size` as obtained from
        :func:`idz_frmi`; `n` is also the length of the output vector.
    :type n: int
    :param w:
        Initialization array constructed by :func:`idz_frmi`.
    :type w: :class:`numpy.ndarray`
    :param x:
        Vector to be transformed.
    :type x: :class:`numpy.ndarray`

    :return:
        Transformed vector.
    :rtype: :class:`numpy.ndarray`
    )r   Úidz_frmr   r   r   r   rm   z  s    rm   c                 C   s   t  | |||¡S )aí  
    Transform complex vector via a composition of Rokhlin's random transform,
    random subselection, and an FFT.

    In contrast to :func:`idz_frm`, this routine works best when the length of
    the transformed vector is known a priori.

    :param l:
        Length of transformed vector, satisfying `l <= n`.
    :type l: int
    :param n:
        Greatest power-of-two integer satisfying `n <= x.size` as obtained from
        :func:`idz_sfrmi`.
    :type n: int
    :param w:
        Initialization array constructed by :func:`idd_sfrmi`.
    :type w: :class:`numpy.ndarray`
    :param x:
        Vector to be transformed.
    :type x: :class:`numpy.ndarray`

    :return:
        Transformed vector.
    :rtype: :class:`numpy.ndarray`
    )r   Úidz_sfrmr   r   r   r   rn   —  s    rn   c                 C   s
   t  | ¡S )aC  
    Initialize data for :func:`idz_frm`.

    :param m:
        Length of vector to be transformed.
    :type m: int

    :return:
        Greatest power-of-two integer `n` satisfying `n <= m`.
    :rtype: int
    :return:
        Initialization array to be used by :func:`idz_frm`.
    :rtype: :class:`numpy.ndarray`
    )r   Úidz_frmir   r   r   r   ro   ´  s    ro   c                 C   s   t  | |¡S )a•  
    Initialize data for :func:`idz_sfrm`.

    :param l:
        Length of output transformed vector.
    :type l: int
    :param m:
        Length of the vector to be transformed.
    :type m: int

    :return:
        Greatest power-of-two integer `n` satisfying `n <= m`.
    :rtype: int
    :return:
        Initialization array to be used by :func:`idz_sfrm`.
    :rtype: :class:`numpy.ndarray`
    )r   Ú	idz_sfrmir   r   r   r   rp   Æ  s    rp   c                 C   sZ   t |ƒ}t | |¡\}}}|jd }|j ¡ d|||  … j||| fdd�}|||fS )a¡  
    Compute ID of a complex matrix to a specified relative precision.

    :param eps:
        Relative precision.
    :type eps: float
    :param A:
        Matrix.
    :type A: :class:`numpy.ndarray`

    :return:
        Rank of ID.
    :rtype: int
    :return:
        Column index array.
    :rtype: :class:`numpy.ndarray`
    :return:
        Interpolation coefficients.
    :rtype: :class:`numpy.ndarray`
    r    Nr   r   )r   r   Úidzp_idr"   r#   r$   r%   r&   r   r   r   rq   ß  s
    
,rq   c                 C   sV   t | ƒ} t | |¡\}}| jd }| j ¡ d|||  … j||| fdd�}||fS )aT  
    Compute ID of a complex matrix to a specified rank.

    :param A:
        Matrix.
    :type A: :class:`numpy.ndarray`
    :param k:
        Rank of ID.
    :type k: int

    :return:
        Column index array.
    :rtype: :class:`numpy.ndarray`
    :return:
        Interpolation coefficients.
    :rtype: :class:`numpy.ndarray`
    r    Nr   r   )r   r   Úidzr_idr"   r#   r$   r%   r-   r   r   r   rr   û  s
    
,rr   c                 C   s<   t  | ¡} |jdkr"t | ||¡S | dd…t  |¡f S dS )av  
    Reconstruct matrix from complex ID.

    :param B:
        Skeleton matrix.
    :type B: :class:`numpy.ndarray`
    :param idx:
        Column index array.
    :type idx: :class:`numpy.ndarray`
    :param proj:
        Interpolation coefficients.
    :type proj: :class:`numpy.ndarray`

    :return:
        Reconstructed matrix.
    :rtype: :class:`numpy.ndarray`
    r   N)r   r	   r.   r   Úidz_reconidr0   r1   r   r   r   rs     s    

rs   c                 C   s   t  | |¡S )a9  
    Reconstruct interpolation matrix from complex ID.

    :param idx:
        Column index array.
    :type idx: :class:`numpy.ndarray`
    :param proj:
        Interpolation coefficients.
    :type proj: :class:`numpy.ndarray`

    :return:
        Interpolation matrix.
    :rtype: :class:`numpy.ndarray`
    )r   Úidz_reconintr4   r   r   r   rt   -  s    rt   c                 C   s   t  | ¡} t | ||¡S )aQ  
    Reconstruct skeleton matrix from complex ID.

    :param A:
        Original matrix.
    :type A: :class:`numpy.ndarray`
    :param k:
        Rank of ID.
    :type k: int
    :param idx:
        Column index array.
    :type idx: :class:`numpy.ndarray`

    :return:
        Skeleton matrix.
    :rtype: :class:`numpy.ndarray`
    )r   r	   r   Úidz_copycolsr6   r   r   r   ru   ?  s    
ru   c                 C   s2   t  | ¡} t | ||¡\}}}}|r(t‚|||fS )a  
    Convert complex ID to SVD.

    :param B:
        Skeleton matrix.
    :type B: :class:`numpy.ndarray`
    :param idx:
        Column index array.
    :type idx: :class:`numpy.ndarray`
    :param proj:
        Interpolation coefficients.
    :type proj: :class:`numpy.ndarray`

    :return:
        Left singular vectors.
    :rtype: :class:`numpy.ndarray`
    :return:
        Right singular vectors.
    :rtype: :class:`numpy.ndarray`
    :return:
        Singular values.
    :rtype: :class:`numpy.ndarray`
    )r   r	   r   Ú
idz_id2svdr8   r9   r   r   r   rv   Y  s
    
rv   c                 C   s   t  | ||||¡\}}|S )a  
    Estimate spectral norm of a complex matrix by the randomized power method.

    :param m:
        Matrix row dimension.
    :type m: int
    :param n:
        Matrix column dimension.
    :type n: int
    :param matveca:
        Function to apply the matrix adjoint to a vector, with call signature
        `y = matveca(x)`, where `x` and `y` are the input and output vectors,
        respectively.
    :type matveca: function
    :param matvec:
        Function to apply the matrix to a vector, with call signature
        `y = matvec(x)`, where `x` and `y` are the input and output vectors,
        respectively.
    :type matvec: function
    :param its:
        Number of power method iterations.
    :type its: int

    :return:
        Spectral norm estimate.
    :rtype: float
    )r   Ú	idz_snorm)r   r   ÚmatvecarA   rB   rC   rD   r   r   r   rw   |  s    rw   c              	   C   s   t  | ||||||¡S )a/  
    Estimate spectral norm of the difference of two complex matrices by the
    randomized power method.

    :param m:
        Matrix row dimension.
    :type m: int
    :param n:
        Matrix column dimension.
    :type n: int
    :param matveca:
        Function to apply the adjoint of the first matrix to a vector, with
        call signature `y = matveca(x)`, where `x` and `y` are the input and
        output vectors, respectively.
    :type matveca: function
    :param matveca2:
        Function to apply the adjoint of the second matrix to a vector, with
        call signature `y = matveca2(x)`, where `x` and `y` are the input and
        output vectors, respectively.
    :type matveca2: function
    :param matvec:
        Function to apply the first matrix to a vector, with call signature
        `y = matvec(x)`, where `x` and `y` are the input and output vectors,
        respectively.
    :type matvec: function
    :param matvec2:
        Function to apply the second matrix to a vector, with call signature
        `y = matvec2(x)`, where `x` and `y` are the input and output vectors,
        respectively.
    :type matvec2: function
    :param its:
        Number of power method iterations.
    :type its: int

    :return:
        Spectral norm estimate of matrix difference.
    :rtype: float
    )r   Úidz_diffsnorm)r   r   rx   Zmatveca2rA   rF   rB   r   r   r   ry   œ  s    'ry   c                 C   s0   t  | ¡} t | |¡\}}}}|r&t‚|||fS )až  
    Compute SVD of a complex matrix to a specified rank.

    :param A:
        Matrix.
    :type A: :class:`numpy.ndarray`
    :param k:
        Rank of SVD.
    :type k: int

    :return:
        Left singular vectors.
    :rtype: :class:`numpy.ndarray`
    :return:
        Right singular vectors.
    :rtype: :class:`numpy.ndarray`
    :return:
        Singular values.
    :rtype: :class:`numpy.ndarray`
    )r   r	   r   Úidzr_svdr8   rH   r   r   r   rz   Ê  s
    
rz   c                 C   sª   t  |¡}|j\}}t | |¡\}}}}}}	|	r4t‚||d |||  d … j||fdd�}
||d |||  d … j||fdd�}||d || d … }|
||fS )a¹  
    Compute SVD of a complex matrix to a specified relative precision.

    :param eps:
        Relative precision.
    :type eps: float
    :param A:
        Matrix.
    :type A: :class:`numpy.ndarray`

    :return:
        Left singular vectors.
    :rtype: :class:`numpy.ndarray`
    :return:
        Right singular vectors.
    :rtype: :class:`numpy.ndarray`
    :return:
        Singular values.
    :rtype: :class:`numpy.ndarray`
    r    r   r   )r   r	   r"   r   Úidzp_svdr8   r%   rJ   r   r   r   r{   æ  s    

**r{   c           	      C   sŠ   t  |¡}|j\}}t|ƒ\}}t j|d| d  | d ddd�}t | |||¡\}}}|d|||  … j||| fdd�}|||fS )a»  
    Compute ID of a complex matrix to a specified relative precision using
    random sampling.

    :param eps:
        Relative precision.
    :type eps: float
    :param A:
        Matrix.
    :type A: :class:`numpy.ndarray`

    :return:
        Rank of ID.
    :rtype: int
    :return:
        Column index array.
    :rtype: :class:`numpy.ndarray`
    :return:
        Interpolation coefficients.
    :rtype: :class:`numpy.ndarray`
    rN   r    Ú
complex128r   r`   Nr   )r   r	   r"   ro   rO   r   Úidzp_aidr%   rQ   r   r   r   r}   
  s    

$&r}   c                 C   s\   t  |¡}|j\}}t|ƒ\}}t j|| |d |d   ddd�}t | |||¡\}}|S )ah  
    Estimate rank of a complex matrix to a specified relative precision using
    random sampling.

    The output rank is typically about 8 higher than the actual rank.

    :param eps:
        Relative precision.
    :type eps: float
    :param A:
        Matrix.
    :type A: :class:`numpy.ndarray`

    :return:
        Rank estimate.
    :rtype: int
    r    r|   r   r`   )r   r	   r"   ro   rO   r   Úidz_estrankrT   r   r   r   r~   )  s    

$r~   c                 C   s  t  |¡}|j\}}t |¡\}}t jtt||ƒd d| d|  d  dt||ƒd   d| d |d  ƒt jdd�}t 	| |||¡\}}}	}
}}|ržt
‚||d |||  d … j||fdd	�}||	d |	||  d … j||fdd	�}||
d |
| d … }|||fS )
aÓ  
    Compute SVD of a complex matrix to a specified relative precision using
    random sampling.

    :param eps:
        Relative precision.
    :type eps: float
    :param A:
        Matrix.
    :type A: :class:`numpy.ndarray`

    :return:
        Left singular vectors.
    :rtype: :class:`numpy.ndarray`
    :return:
        Right singular vectors.
    :rtype: :class:`numpy.ndarray`
    :return:
        Singular values.
    :rtype: :class:`numpy.ndarray`
    r    rV   rW   é   é   rN   r   r`   r   )r   r	   r"   r   ro   rO   rY   rZ   r|   Ú	idzp_asvdr8   r%   r\   r   r   r   r�   G  s"    

4ÿ ý**r�   c                 C   s~   t j|d d| t||ƒd   t jdd�}t | ||||¡\}}}}|rNt‚|d|||  … j||| fdd�}|||fS )aì  
    Compute ID of a complex matrix to a specified relative precision using
    random matrix-vector multiplication.

    :param eps:
        Relative precision.
    :type eps: float
    :param m:
        Matrix row dimension.
    :type m: int
    :param n:
        Matrix column dimension.
    :type n: int
    :param matveca:
        Function to apply the matrix adjoint to a vector, with call signature
        `y = matveca(x)`, where `x` and `y` are the input and output vectors,
        respectively.
    :type matveca: function

    :return:
        Rank of ID.
    :rtype: int
    :return:
        Column index array.
    :rtype: :class:`numpy.ndarray`
    :return:
        Interpolation coefficients.
    :rtype: :class:`numpy.ndarray`
    r    rN   r   r`   Nr   )r   rO   rZ   r|   r   Úidzp_ridr8   r%   )r'   r   r   rx   r+   r(   r)   r=   r   r   r   r‚   q  s     þ&r‚   c                 C   s"   t  | |||¡\}}}|rt‚|S )aR  
    Estimate rank of a complex matrix to a specified relative precision using
    random matrix-vector multiplication.

    :param eps:
        Relative precision.
    :type eps: float
    :param m:
        Matrix row dimension.
    :type m: int
    :param n:
        Matrix column dimension.
    :type n: int
    :param matveca:
        Function to apply the matrix adjoint to a vector, with call signature
        `y = matveca(x)`, where `x` and `y` are the input and output vectors,
        respectively.
    :type matveca: function

    :return:
        Rank estimate.
    :rtype: int
    )r   Úidz_findrankr8   )r'   r   r   rx   r(   rU   r=   r   r   r   rƒ   ™  s    rƒ   c                 C   sœ   t  | ||||¡\}}}}}	}
|
r&t‚|	|d |||  d … j||fdd�}|	|d |||  d … j||fdd�}|	|d || d … }|||fS )aÛ  
    Compute SVD of a complex matrix to a specified relative precision using
    random matrix-vector multiplication.

    :param eps:
        Relative precision.
    :type eps: float
    :param m:
        Matrix row dimension.
    :type m: int
    :param n:
        Matrix column dimension.
    :type n: int
    :param matveca:
        Function to apply the matrix adjoint to a vector, with call signature
        `y = matveca(x)`, where `x` and `y` are the input and output vectors,
        respectively.
    :type matveca: function
    :param matvec:
        Function to apply the matrix to a vector, with call signature
        `y = matvec(x)`, where `x` and `y` are the input and output vectors,
        respectively.
    :type matvec: function

    :return:
        Left singular vectors.
    :rtype: :class:`numpy.ndarray`
    :return:
        Right singular vectors.
    :rtype: :class:`numpy.ndarray`
    :return:
        Singular values.
    :rtype: :class:`numpy.ndarray`
    r    r   r   )r   Ú	idzp_rsvdr8   r%   )r'   r   r   rx   rA   r(   rK   rL   rM   r   r=   r:   r;   r<   r   r   r   r„   »  s    #**r„   c                 C   sr   t  | ¡} | j\}}t|||ƒ}t | ||¡\}}||krTt j||| fddd�}n|j||| fdd�}||fS )aj  
    Compute ID of a complex matrix to a specified rank using random sampling.

    :param A:
        Matrix.
    :type A: :class:`numpy.ndarray`
    :param k:
        Rank of ID.
    :type k: int

    :return:
        Column index array.
    :rtype: :class:`numpy.ndarray`
    :return:
        Interpolation coefficients.
    :rtype: :class:`numpy.ndarray`
    r|   r   r`   r   )r   r	   r"   Ú	idzr_aidir   Úidzr_aidrO   r%   rc   r   r   r   r†   ë  s    

r†   c                 C   s   t  | ||¡S )aO  
    Initialize array for :func:`idzr_aid`.

    :param m:
        Matrix row dimension.
    :type m: int
    :param n:
        Matrix column dimension.
    :type n: int
    :param k:
        Rank of ID.
    :type k: int

    :return:
        Initialization array to be used by :func:`idzr_aid`.
    :rtype: :class:`numpy.ndarray`
    )r   r…   rd   r   r   r   r…     s    r…   c           
      C   sš   t  | ¡} | j\}}t jd| d | d| d |  d|d   d|  d dd	d
�}t|||ƒ}||d|j…< t | ||¡\}}}}	|	r�t‚|||fS )a´  
    Compute SVD of a complex matrix to a specified rank using random sampling.

    :param A:
        Matrix.
    :type A: :class:`numpy.ndarray`
    :param k:
        Rank of SVD.
    :type k: int

    :return:
        Left singular vectors.
    :rtype: :class:`numpy.ndarray`
    :return:
        Right singular vectors.
    :rtype: :class:`numpy.ndarray`
    :return:
        Singular values.
    :rtype: :class:`numpy.ndarray`
    rN   é   rf   rg   r€   é
   éZ   r|   r   r`   N)	r   r	   r"   rO   r…   r.   r   Ú	idzr_asvdr8   rj   r   r   r   rŠ   !  s    

6 þrŠ   c                 C   sB   t  | |||¡\}}|d|||  … j||| fdd�}||fS )aŸ  
    Compute ID of a complex matrix to a specified rank using random
    matrix-vector multiplication.

    :param m:
        Matrix row dimension.
    :type m: int
    :param n:
        Matrix column dimension.
    :type n: int
    :param matveca:
        Function to apply the matrix adjoint to a vector, with call signature
        `y = matveca(x)`, where `x` and `y` are the input and output vectors,
        respectively.
    :type matveca: function
    :param k:
        Rank of ID.
    :type k: int

    :return:
        Column index array.
    :rtype: :class:`numpy.ndarray`
    :return:
        Interpolation coefficients.
    :rtype: :class:`numpy.ndarray`
    Nr   r   )r   Úidzr_ridr%   )r   r   rx   r(   r)   r+   r   r   r   r‹   G  s    &r‹   c           	      C   s,   t  | ||||¡\}}}}|r"t‚|||fS )aÀ  
    Compute SVD of a complex matrix to a specified rank using random
    matrix-vector multiplication.

    :param m:
        Matrix row dimension.
    :type m: int
    :param n:
        Matrix column dimension.
    :type n: int
    :param matveca:
        Function to apply the matrix adjoint to a vector, with call signature
        `y = matveca(x)`, where `x` and `y` are the input and output vectors,
        respectively.
    :type matveca: function
    :param matvec:
        Function to apply the matrix to a vector, with call signature
        `y = matvec(x)`, where `x` and `y` are the input and output vectors,
        respectively.
    :type matvec: function
    :param k:
        Rank of SVD.
    :type k: int

    :return:
        Left singular vectors.
    :rtype: :class:`numpy.ndarray`
    :return:
        Right singular vectors.
    :rtype: :class:`numpy.ndarray`
    :return:
        Singular values.
    :rtype: :class:`numpy.ndarray`
    )r   Ú	idzr_rsvdr8   )	r   r   rx   rA   r(   r:   r;   r<   r=   r   r   r   rŒ   k  s    #rŒ   )r>   )r>   )r>   )r>   )?Ú__doc__Zscipy.linalg._interpolativeZlinalgZ_interpolativer   Únumpyr   ÚRuntimeErrorr8   r   r   r   r   r   r   r   r   r!   r,   r/   r3   r5   r7   r?   rE   rG   rI   rP   rS   r[   r]   r^   r_   rb   ra   ri   rk   rl   rm   rn   ro   rp   rq   rr   rs   rt   ru   rv   rw   ry   rz   r{   r}   r~   r�   r‚   rƒ   r„   r†   r…   rŠ   r‹   rŒ   r   r   r   r   Ú<module>   sr   #
 
.$*&"0$$-#
 
.$*("0&$