o
    §ƒðjÉL  ã                   @   s  d Z ddlmZ ddlmZ ddlmZ ddlmZm	Z	 ddl
mZ ddlmZ ddlmZ dd	lmZ dd
lmZ ddlmZ ddlmZmZ ddlmZ ddlmZ g d¢ZG dd„ deƒZG dd„ deƒZG dd„ deƒZ G dd„ deƒZ!G dd„ deƒZ"G dd„ deƒZ#dS )a  Quantum mechanical operators.

TODO:

* Fix early 0 in apply_operators.
* Debug and test apply_operators.
* Get cse working with classes in this file.
* Doctests and documentation of special methods for InnerProduct, Commutator,
  AntiCommutator, represent, apply_operators.
é    )ÚOptional)ÚAdd)ÚExpr)Ú
DerivativeÚexpand)ÚMul©Úoo©ÚS©Ú
prettyForm)ÚDagger)ÚOperatorKind)ÚQExprÚdispatch_method)Úeye)Úsympy_deprecation_warning)ÚOperatorÚHermitianOperatorÚUnitaryOperatorÚIdentityOperatorÚOuterProductÚDifferentialOperatorc                   @   s®   e Zd ZU dZdZee ed< dZee ed< e	dd„ ƒZ
eZdZdd	„ Ze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eZdd„ ZdS ) r   a
  Base class for non-commuting quantum operators.

    An operator maps between quantum states [1]_. In quantum mechanics,
    observables (including, but not limited to, measured physical values) are
    represented as Hermitian operators [2]_.

    Parameters
    ==========

    args : tuple
        The list of numbers or parameters that uniquely specify the
        operator. For time-dependent operators, this will include the time.

    Examples
    ========

    Create an operator and examine its attributes::

        >>> from sympy.physics.quantum import Operator
        >>> from sympy import I
        >>> A = Operator('A')
        >>> A
        A
        >>> A.hilbert_space
        H
        >>> A.label
        (A,)
        >>> A.is_commutative
        False

    Create another operator and do some arithmetic operations::

        >>> B = Operator('B')
        >>> C = 2*A*A + I*B
        >>> C
        2*A**2 + I*B

    Operators do not commute::

        >>> A.is_commutative
        False
        >>> B.is_commutative
        False
        >>> A*B == B*A
        False

    Polymonials of operators respect the commutation properties::

        >>> e = (A+B)**3
        >>> e.expand()
        A*B*A + A*B**2 + A**2*B + A**3 + B*A*B + B*A**2 + B**2*A + B**3

    Operator inverses are handle symbolically::

        >>> A.inv()
        A**(-1)
        >>> A*A.inv()
        1

    References
    ==========

    .. [1] https://en.wikipedia.org/wiki/Operator_%28physics%29
    .. [2] https://en.wikipedia.org/wiki/Observable
    NÚis_hermitianÚ
is_unitaryc                 C   ó   dS )N)ÚO© ©Úselfr   r   ú /tmp/claude-1000/-var-www-html-academy/3f42efd1-c2b7-4d08-9b05-30d86bb35479/scratchpad/piper/venv/lib/python3.10/site-packages/sympy/physics/quantum/operator.pyÚdefault_argsn   s   zOperator.default_argsú,c                 G   ó   | j jS ©N)Ú	__class__Ú__name__©r    ÚprinterÚargsr   r   r!   Ú_print_operator_namez   ó   zOperator._print_operator_namec                 G   s   t | jjƒS r%   )r   r&   r'   r(   r   r   r!   Ú_print_operator_name_pretty   s   z$Operator._print_operator_name_prettyc                 G   óH   t | jƒdkr| j|g|¢R Ž S d| j|g|¢R Ž | j|g|¢R Ž f S )Né   ú%s(%s))ÚlenÚlabelÚ_print_labelr+   r(   r   r   r!   Ú_print_contents‚   ó   þzOperator._print_contentsc                 G   sh   t | jƒdkr| j|g|¢R Ž S | j|g|¢R Ž }| j|g|¢R Ž }t|jddd�Ž }t| |¡Ž }|S )Nr/   ú(ú)©ÚleftÚright)r1   r2   Ú_print_label_prettyr-   r   Úparensr:   ©r    r)   r*   ÚpformÚlabel_pformr   r   r!   Ú_print_contents_pretty‹   s   ÿzOperator._print_contents_prettyc                 G   r.   )Nr/   z%s\left(%s\right))r1   r2   Ú_print_label_latexÚ_print_operator_name_latexr(   r   r   r!   Ú_print_contents_latex—   r5   zOperator._print_contents_latexc                 K   ó   t | d|fi |¤ŽS )z:Evaluate [self, other] if known, return None if not known.Ú_eval_commutator©r   ©r    ÚotherÚoptionsr   r   r!   rE   ¤   ó   zOperator._eval_commutatorc                 K   rD   )z Evaluate [self, other] if known.Ú_eval_anticommutatorrF   rG   r   r   r!   rK   ¨   rJ   zOperator._eval_anticommutatorc                 K   rD   )NÚ_apply_operatorrF   ©r    ÚketrI   r   r   r!   rL   °   s   zOperator._apply_operatorc                 K   s   d S r%   r   ©r    ÚbrarI   r   r   r!   Ú_apply_from_right_to³   ó   zOperator._apply_from_right_toc                 G   s   t dƒ‚)Nzmatrix_elements is not defined)ÚNotImplementedError)r    r*   r   r   r!   Úmatrix_element¶   r,   zOperator.matrix_elementc                 C   ó   |   ¡ S r%   ©Ú_eval_inverser   r   r   r!   Úinverse¹   r,   zOperator.inversec                 C   s   | d S ©Néÿÿÿÿr   r   r   r   r!   rW   ¾   r,   zOperator._eval_inverse)r'   Ú
__module__Ú__qualname__Ú__doc__r   r   ÚboolÚ__annotations__r   Úclassmethodr"   r   ÚkindÚ_label_separatorr+   rB   r-   r4   r@   rC   rE   rK   rL   rQ   rT   rX   ÚinvrW   r   r   r   r!   r   *   s,   
 A
	r   c                   @   s$   e Zd ZdZdZdd„ Zdd„ ZdS )r   a”  A Hermitian operator that satisfies H == Dagger(H).

    Parameters
    ==========

    args : tuple
        The list of numbers or parameters that uniquely specify the
        operator. For time-dependent operators, this will include the time.

    Examples
    ========

    >>> from sympy.physics.quantum import Dagger, HermitianOperator
    >>> H = HermitianOperator('H')
    >>> Dagger(H)
    H
    Tc                 C   s   t | tƒr| S t | ¡S r%   )Ú
isinstancer   r   rW   r   r   r   r!   rW   ×   s   

zHermitianOperator._eval_inversec                 C   s8   t | tƒr|jrddlm} |jS |jr| S t | |¡S )Nr   r
   )	rd   r   Úis_evenÚsympy.core.singletonr   ÚOneÚis_oddr   Ú_eval_power)r    Úexpr   r   r   r!   ri   Ý   s   
zHermitianOperator._eval_powerN)r'   r[   r\   r]   r   rW   ri   r   r   r   r!   r   Â   s
    r   c                   @   s   e Zd ZdZdZdd„ ZdS )r   a’  A unitary operator that satisfies U*Dagger(U) == 1.

    Parameters
    ==========

    args : tuple
        The list of numbers or parameters that uniquely specify the
        operator. For time-dependent operators, this will include the time.

    Examples
    ========

    >>> from sympy.physics.quantum import Dagger, UnitaryOperator
    >>> U = UnitaryOperator('U')
    >>> U*Dagger(U)
    1
    Tc                 C   rU   r%   rV   r   r   r   r!   Ú_eval_adjointü   r,   zUnitaryOperator._eval_adjointN)r'   r[   r\   r]   r   rk   r   r   r   r!   r   é   s    r   c                   @   s�   e Zd ZdZdZdZedd„ ƒZe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S ) r   a,  An identity operator I that satisfies op * I == I * op == op for any
    operator op.

    .. deprecated:: 1.14.
        Use the scalar S.One instead as the multiplicative identity for
        operators and states.

    Parameters
    ==========

    N : Integer
        Optional parameter that specifies the dimension of the Hilbert space
        of operator. This is used when generating a matrix representation.

    Examples
    ========

    >>> from sympy.physics.quantum import IdentityOperator
    >>> IdentityOperator() # doctest: +SKIP
    I
    Tc                 C   s   | j S r%   )ÚNr   r   r   r!   Ú	dimension  ó   zIdentityOperator.dimensionc                 C   s   t fS r%   r   r   r   r   r!   r"     rn   zIdentityOperator.default_argsc                 O   sR   t dddd� t|ƒdvrtd| ƒ‚t|ƒdkr$|d r$|d | _d S t| _d S )	Nz�
            IdentityOperator has been deprecated. In the future, please use
            S.One as the identity for quantum operators and states.
            z1.14zdeprecated-operator-identity)Údeprecated_since_versionÚactive_deprecations_target)r   r/   z"0 or 1 parameters expected, got %sr/   r   )r   r1   Ú
ValueErrorr	   rl   )r    r*   Úhintsr   r   r!   Ú__init__   s   ú,zIdentityOperator.__init__c                 K   s   t jS r%   )r   ÚZero©r    rH   rr   r   r   r!   rE   .  s   z!IdentityOperator._eval_commutatorc                 K   s   d| S )Né   r   ru   r   r   r!   rK   1  r,   z%IdentityOperator._eval_anticommutatorc                 C   ó   | S r%   r   r   r   r   r!   rW   4  rR   zIdentityOperator._eval_inversec                 C   rw   r%   r   r   r   r   r!   rk   7  rR   zIdentityOperator._eval_adjointc                 K   ó   |S r%   r   rM   r   r   r!   rL   :  rR   z IdentityOperator._apply_operatorc                 K   rx   r%   r   rO   r   r   r!   rQ   =  rR   z%IdentityOperator._apply_from_right_toc                 C   rw   r%   r   )r    rj   r   r   r!   ri   @  rR   zIdentityOperator._eval_powerc                 G   r   ©NÚIr   r(   r   r   r!   r4   C  rR   z IdentityOperator._print_contentsc                 G   s   t dƒS ry   r   r(   r   r   r!   r@   F  r,   z'IdentityOperator._print_contents_prettyc                 G   r   )Nz{\mathcal{I}}r   r(   r   r   r!   rC   I  rR   z&IdentityOperator._print_contents_latexc                 K   sF   | j r| j tkrtdƒ‚| dd¡}|dkrtdd|  ƒ‚t| j ƒS )NzCCannot represent infinite dimensional identity operator as a matrixÚformatÚsympyzRepresentation in format z%s not implemented.)rl   r	   rS   Úgetr   )r    rI   r{   r   r   r!   Ú_represent_default_basisL  s   ÿ
z)IdentityOperator._represent_default_basisN)r'   r[   r\   r]   r   r   Úpropertyrm   r`   r"   rs   rE   rK   rW   rk   rL   rQ   ri   r4   r@   rC   r~   r   r   r   r!   r      s(    

r   c                   @   sl   e Zd ZdZdZdd„ Zedd„ ƒZe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S )r   aß  An unevaluated outer product between a ket and bra.

    This constructs an outer product between any subclass of ``KetBase`` and
    ``BraBase`` as ``|a><b|``. An ``OuterProduct`` inherits from Operator as they act as
    operators in quantum expressions.  For reference see [1]_.

    Parameters
    ==========

    ket : KetBase
        The ket on the left side of the outer product.
    bar : BraBase
        The bra on the right side of the outer product.

    Examples
    ========

    Create a simple outer product by hand and take its dagger::

        >>> from sympy.physics.quantum import Ket, Bra, OuterProduct, Dagger

        >>> k = Ket('k')
        >>> b = Bra('b')
        >>> op = OuterProduct(k, b)
        >>> op
        |k><b|
        >>> op.hilbert_space
        H
        >>> op.ket
        |k>
        >>> op.bra
        <b|
        >>> Dagger(op)
        |b><k|

    In quantum expressions, outer products will be automatically
    identified and created::

        >>> k*b
        |k><b|

    However, the creation of inner products always has higher priority than that of
    outer products:

        >>> b*k*b
        <b|k>*<b|

    References
    ==========

    .. [1] https://en.wikipedia.org/wiki/Outer_product
    Fc                 O   s
  ddl m}m} t|ƒdkrtdt|ƒ ƒ‚t|d ƒ}t|d ƒ}t||tfƒrŸt||tfƒrŸ| ¡ \}}| ¡ \}	}
t|ƒdksIt|d |ƒsQt	dt|Ž  ƒ‚t|
ƒdks^t|
d |ƒsft	dt|
Ž  ƒ‚|d  
¡ |
d jkst	d|d j|
d jf ƒ‚tj| g|d |
d f¢R i |¤Ž}|d j|_t||	 Ž | S g }t|tƒrÇt|tƒrÇ|jD ]}|jD ]}| t||fi |¤Ž¡ q³q®t|Ž S t|tƒrâ|jD ]}| t||fi |¤Ž¡ qÏt|Ž S t|tƒrý|jD ]}| t||fi |¤Ž¡ qêt|Ž S t	d	||f ƒ‚)
Nr   )ÚKetBaseÚBraBaserv   z2 parameters expected, got %dr/   z"KetBase subclass expected, got: %rz"BraBase subclass expected, got: %rz(ket and bra are not dual classes: %r, %rz,Expected ket and bra expression, got: %r, %r)Úsympy.physics.quantum.stater€   r�   r1   rq   r   rd   r   Úargs_cncÚ	TypeErrorÚ
dual_classr&   r   Ú__new__Úhilbert_spacer   r*   Úappendr   )Úclsr*   Úold_assumptionsr€   r�   Úket_exprÚbra_exprÚket_cÚketsÚbra_cÚbrasÚobjÚop_termsÚket_termÚbra_termr   r   r!   r†   �  sj   ÿÿÿÿÿ$


ÿÿ
ò

ÿ
ö

ÿûÿÿzOuterProduct.__new__c                 C   ó
   | j d S )z5Return the ket on the left side of the outer product.r   ©r*   r   r   r   r!   rN   È  ó   
zOuterProduct.ketc                 C   r•   )z6Return the bra on the right side of the outer product.r/   r–   r   r   r   r!   rP   Í  r—   zOuterProduct.brac                 C   s   t t| jƒt| jƒƒS r%   )r   r   rP   rN   r   r   r   r!   rk   Ò  s   zOuterProduct._eval_adjointc                 G   s   |  | j¡|  | j¡ S r%   ©Ú_printrN   rP   r(   r   r   r!   Ú	_sympystrÕ  s   zOuterProduct._sympystrc                 G   s2   d| j j|j| jg|¢R Ž |j| jg|¢R Ž f S )Nz	%s(%s,%s))r&   r'   r™   rN   rP   r(   r   r   r!   Ú
_sympyreprØ  s   $ÿzOuterProduct._sympyreprc                 G   s2   | j j|g|¢R Ž }t| | jj|g|¢R Ž ¡Ž S r%   )rN   Ú_prettyr   r:   rP   )r    r)   r*   r>   r   r   r!   rœ   Ü  s   zOuterProduct._prettyc                 G   s0   |j | jg|¢R Ž }|j | jg|¢R Ž }|| S r%   r˜   )r    r)   r*   ÚkÚbr   r   r!   Ú_latexà  s   zOuterProduct._latexc                 K   s,   | j jdi |¤Ž}| jjdi |¤Ž}|| S )Nr   )rN   Ú
_representrP   )r    rI   r�   rž   r   r   r!   r    å  s   zOuterProduct._representc                 K   s   | j j| jfi |¤ŽS r%   )rN   Ú_eval_tracerP   )r    Úkwargsr   r   r!   r¡   ê  s   zOuterProduct._eval_traceN)r'   r[   r\   r]   Úis_commutativer†   r   rN   rP   rk   rš   r›   rœ   rŸ   r    r¡   r   r   r   r!   r   Y  s    48

r   c                   @   s`   e Zd ZdZedd„ ƒZedd„ ƒZedd„ ƒZedd	„ ƒZd
d„ Z	dd„ Z
dd„ Zdd„ ZdS )r   a+  An operator for representing the differential operator, i.e. d/dx

    It is initialized by passing two arguments. The first is an arbitrary
    expression that involves a function, such as ``Derivative(f(x), x)``. The
    second is the function (e.g. ``f(x)``) which we are to replace with the
    ``Wavefunction`` that this ``DifferentialOperator`` is applied to.

    Parameters
    ==========

    expr : Expr
           The arbitrary expression which the appropriate Wavefunction is to be
           substituted into

    func : Expr
           A function (e.g. f(x)) which is to be replaced with the appropriate
           Wavefunction when this DifferentialOperator is applied

    Examples
    ========

    You can define a completely arbitrary expression and specify where the
    Wavefunction is to be substituted

    >>> from sympy import Derivative, Function, Symbol
    >>> from sympy.physics.quantum.operator import DifferentialOperator
    >>> from sympy.physics.quantum.state import Wavefunction
    >>> from sympy.physics.quantum.qapply import qapply
    >>> f = Function('f')
    >>> x = Symbol('x')
    >>> d = DifferentialOperator(1/x*Derivative(f(x), x), f(x))
    >>> w = Wavefunction(x**2, x)
    >>> d.function
    f(x)
    >>> d.variables
    (x,)
    >>> qapply(d*w)
    Wavefunction(2, x)

    c                 C   s   | j d j S )a�  
        Returns the variables with which the function in the specified
        arbitrary expression is evaluated

        Examples
        ========

        >>> from sympy.physics.quantum.operator import DifferentialOperator
        >>> from sympy import Symbol, Function, Derivative
        >>> x = Symbol('x')
        >>> f = Function('f')
        >>> d = DifferentialOperator(1/x*Derivative(f(x), x), f(x))
        >>> d.variables
        (x,)
        >>> y = Symbol('y')
        >>> d = DifferentialOperator(Derivative(f(x, y), x) +
        ...                          Derivative(f(x, y), y), f(x, y))
        >>> d.variables
        (x, y)
        rZ   r–   r   r   r   r!   Ú	variables  s   zDifferentialOperator.variablesc                 C   r•   )ad  
        Returns the function which is to be replaced with the Wavefunction

        Examples
        ========

        >>> from sympy.physics.quantum.operator import DifferentialOperator
        >>> from sympy import Function, Symbol, Derivative
        >>> x = Symbol('x')
        >>> f = Function('f')
        >>> d = DifferentialOperator(Derivative(f(x), x), f(x))
        >>> d.function
        f(x)
        >>> y = Symbol('y')
        >>> d = DifferentialOperator(Derivative(f(x, y), x) +
        ...                          Derivative(f(x, y), y), f(x, y))
        >>> d.function
        f(x, y)
        rZ   r–   r   r   r   r!   Úfunction4  s   
zDifferentialOperator.functionc                 C   r•   )a¯  
        Returns the arbitrary expression which is to have the Wavefunction
        substituted into it

        Examples
        ========

        >>> from sympy.physics.quantum.operator import DifferentialOperator
        >>> from sympy import Function, Symbol, Derivative
        >>> x = Symbol('x')
        >>> f = Function('f')
        >>> d = DifferentialOperator(Derivative(f(x), x), f(x))
        >>> d.expr
        Derivative(f(x), x)
        >>> y = Symbol('y')
        >>> d = DifferentialOperator(Derivative(f(x, y), x) +
        ...                          Derivative(f(x, y), y), f(x, y))
        >>> d.expr
        Derivative(f(x, y), x) + Derivative(f(x, y), y)
        r   r–   r   r   r   r!   ÚexprL  s   
zDifferentialOperator.exprc                 C   r$   )z<
        Return the free symbols of the expression.
        )r¦   Úfree_symbolsr   r   r   r!   r§   e  s   z!DifferentialOperator.free_symbolsc                 K   sP   ddl m} | j}|jdd … }| j}| j |||Ž ¡}| ¡ }||g|¢R Ž S )Nr   )ÚWavefunctionr/   )r‚   r¨   r¤   r*   r¥   r¦   ÚsubsÚdoit)r    ÚfuncrI   r¨   ÚvarÚwf_varsÚfÚnew_exprr   r   r!   Ú_apply_operator_Wavefunctionm  s   z1DifferentialOperator._apply_operator_Wavefunctionc                 C   s   t | j|ƒ}t|| jd ƒS rY   )r   r¦   r   r*   )r    Úsymbolr¯   r   r   r!   Ú_eval_derivativex  s   z%DifferentialOperator._eval_derivativec                 G   s(   d| j |g|¢R Ž | j|g|¢R Ž f S )Nr0   )r+   r3   r(   r   r   r!   r™   €  s   þzDifferentialOperator._printc                 G   sH   | j |g|¢R Ž }| j|g|¢R Ž }t|jddd�Ž }t| |¡Ž }|S )Nr6   r7   r8   )r-   r;   r   r<   r:   r=   r   r   r!   Ú_print_pretty†  s   ÿz"DifferentialOperator._print_prettyN)r'   r[   r\   r]   r   r¤   r¥   r¦   r§   r°   r²   r™   r³   r   r   r   r!   r   ñ  s    )



r   N)$r]   Útypingr   Úsympy.core.addr   Úsympy.core.exprr   Úsympy.core.functionr   r   Úsympy.core.mulr   Úsympy.core.numbersr	   rf   r   Ú sympy.printing.pretty.stringpictr   Úsympy.physics.quantum.daggerr   Úsympy.physics.quantum.kindr   Úsympy.physics.quantum.qexprr   r   Úsympy.matricesr   Úsympy.utilities.exceptionsr   Ú__all__r   r   r   r   r   r   r   r   r   r!   Ú<module>   s.    
 'Y 