o
    EbA                     @   s  d Z ddlZddlmZmZmZ ddlZddlmZ ddl	Z
ddl	mZmZ ddlmZmZ ddlmZmZmZmZ ddlmZ d	d
 Zdd Zdd Zdd ZG dd deZdd ZG dd dZG dd dZG dd dZG dd dZ G dd dZ!G dd  d Z"G d!d" d"Z#dS )#zA
Unit tests for the basin hopping global minimization algorithm.
    N)assert_almost_equalassert_equalassert_)raises)cossin)basinhoppingOptimizeResult)StorageRandomDisplacement
MetropolisAdaptiveStepsize)Versionc                 C   sJ   t d|  d | d |   }tdtd|  d  d|   d }||fS )N      -@333333?皙?      -       @)r   nparrayr   xfZdf r   I/usr/lib/python3/dist-packages/scipy/optimize/tests/test__basinhopping.pyfunc1d   s   &r   c                 C   s@   t d| d  d | d d | d   | d d | d   }|S )Nr   r   r      r   )r   )r   r   r   r   r   func2d_nograd   s   <r   c                 C   s   t d| d  d | d d | d   | d d | d   }td}dtd| d  d  d| d   d |d< d| d  d |d< ||fS )	Nr   r   r   r   r      r   r   )r   r   zerosr   r   r   r   r   func2d   s
   <
,r    c                 C   s   d| d d  d| d  | d   d| d d   d| d   }t d}d| d  d| d   d |d< d| d  d| d   |d< ||fS )Nr   r   r   r   g      @g      @)r   r   r   r   r   r   func2d_easyderiv%   s
   @
 r!   c                       s,   e Zd ZdZ fddZ fddZ  ZS )MyTakeStep1zfuse a copy of displace, but have it set a special parameter to
    make sure it's actually being used.c                    s   d| _ t   d S )NF)been_calledsuper__init__self	__class__r   r   r%   1   s   zMyTakeStep1.__init__c                    s   d| _ t |S )NT)r#   r$   __call__)r'   r   r(   r   r   r*   5   s   zMyTakeStep1.__call__)__name__
__module____qualname____doc__r%   r*   __classcell__r   r   r(   r   r"   .   s    r"   c                 C   s$   d}| t j| |t | 7 } | S )zwredo RandomDisplacement in function form without the attribute stepsize
    to make sure everything still works ok
          ?)r   randomZuniformshape)r   sr   r   r   myTakeStep2:   s   r4   c                   @       e Zd ZdZdd Zdd ZdS )MyAcceptTestzpass a custom accept test

    This does nothing but make sure it's being used and ensure all the
    possible return values are accepted
    c              	   C   s4   d| _ d| _dddtdtdg i ddg	| _d S )NFr   zforce acceptTr   )r#   ncallsr   Zbool_testresr&   r   r   r   r%   I   s
   
zMyAcceptTest.__init__c                 K   s<   d| _ |  jd7  _| jd t| jk r| j| jd  S dS )NTr   )r#   r7   lenr8   )r'   kwargsr   r   r   r*   O   s
   zMyAcceptTest.__call__Nr+   r,   r-   r.   r%   r*   r   r   r   r   r6   C   s    r6   c                   @   r5   )
MyCallBackzpass a custom callback function

    This makes sure it's being used. It also returns True after 10
    steps to ensure that it's stopping early.

    c                 C   s   d| _ d| _d S )NFr   r#   r7   r&   r   r   r   r%   _   s   
zMyCallBack.__init__c                 C   s&   d| _ |  jd7  _| jdkrdS d S )NTr   
   r=   )r'   r   r   acceptedr   r   r   r*   c   s
   
zMyCallBack.__call__Nr;   r   r   r   r   r<   X   s    r<   c                   @   s   e Z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dd Zdd  Zd!d" Zejjeejed#k d$d%d&d' Zd(d) Zd*S )+TestBasinHoppingc                 C   sZ   dddgf| _ dtddgf| _d| _d| _d| _tjd dd	d
| _	ddi| _
dS )z] Tests setup.

        Run tests based on the 1-D and 2-D functions described above.
              ?g(\ȿg   d   Fi  L-BFGS-BTmethodjacrF   N)x0r   r   soltolniterdispr1   seedr:   kwargs_nogradr&   r   r   r   setup_methodl   s   zTestBasinHopping.setup_methodc                 C   s8   d}t ttt| j| dd t ttt| j| dd d S )Nr   )	take_step)accept_test)assert_raises	TypeErrorr   r    rH   r'   ir   r   r   test_TypeError   s   
zTestBasinHopping.test_TypeErrorc                 C   s  d}t t|d tt| jd dd W d    n1 sw   Y  t t|d tt| jd dd W d    n1 s=w   Y  d}t t|d tt| jd dd W d    n1 s_w   Y  t t|d tt| jd dd W d    d S 1 sw   Y  d S )	Nz.target_accept_rate has to be in range \(0, 1\))matchr           )target_accept_raterA   z+stepwise_factor has to be in range \(0, 1\))Zstepwise_factor)rR   
ValueErrorr   r   rH   )r'   msgr   r   r   test_input_validation   s   "z&TestBasinHopping.test_input_validationc                 C   <   d}t t| j| | j| j| jd}t|j| j| | j	 d S Nr   minimizer_kwargsrK   rL   
r   r   rH   r:   rK   rL   r   r   rI   rJ   r'   rU   resr   r   r   test_1d_grad   s
   zTestBasinHopping.test_1d_gradc                 C   sJ   d}t t| j| | j| j| jd}t|j| j| | j	 t
|jdk d S )Nr   r_   r   )r   r    rH   r:   rK   rL   r   r   rI   rJ   r   nfevrb   r   r   r   test_2d   s   zTestBasinHopping.test_2dc                 C   sR   d}| j  }d|d< tt| j| || j| jd}t|jdk t	|j|j
 d S )Nr   BFGSrF   r_   r   )r:   copyr   r    rH   rK   rL   r   re   r   Znjev)r'   rU   r`   rc   r   r   r   	test_njev   s   
zTestBasinHopping.test_njevc                 C   s`   | j  }d|d< ttddg|| j| jd}tt|jd t|j	\}}t
|jj|| j d S )Nrg   rF   rX   r_   rG   )r:   rh   r   r!   rK   rL   r   hasattrZlowest_optimization_resultr   r   rG   rJ   )r'   r`   rc   _Zjacobianr   r   r   test_jac   s   


zTestBasinHopping.test_jacc                 C   r]   )Nr   r_   )
r   r   rH   rN   rK   rL   r   r   rI   rJ   rb   r   r   r   test_2d_nograd   s   zTestBasinHopping.test_2d_nogradc                 C   s`   d}g d}t  | j}|D ]}||d< tt| j| || j| jd}t|j| j	| | j
 qd S )Nr   )CGrg   z	Newton-CGrD   TNCSLSQPrF   r_   )rh   r:   r   r    rH   rK   rL   r   r   rI   rJ   )r'   rU   methodsr`   rF   rc   r   r   r   test_all_minimizers   s   z$TestBasinHopping.test_all_minimizersc                 C   sr   d}g d}t  | j}|D ](}||d< tt| j| || j| jd}| j}|dkr+d}t|j	| j
| |d qd S )Nr   )rn   rg   rD   ro   rp   zNelder-MeadZPowellCOBYLArF   r_   rs   r   )Zdecimal)rh   rN   r   r   rH   rK   rL   rJ   r   r   rI   )r'   rU   rq   r`   rF   rc   rJ   r   r   r   test_all_nograd_minimizers   s   z+TestBasinHopping.test_all_nograd_minimizersc                 C   sb   t  }|j}d}tt| j| | j| j| j|d}t|j	| j
| | j t|j t||jk d S Nr   )r`   rK   rL   rP   )r"   stepsizer   r    rH   r:   rK   rL   r   r   rI   rJ   r   r#   )r'   takestepZinitial_step_sizerU   rc   r   r   r   test_pass_takestep   s   
z#TestBasinHopping.test_pass_takestepc                 C   sB   t }d}tt| j| | j| j| j|d}t|j| j	| | j
 d S ru   )r4   r   r   rH   rN   rK   rL   r   r   rI   rJ   )r'   rw   rU   rc   r   r   r   test_pass_simple_takestep   s   z*TestBasinHopping.test_pass_simple_takestepc                 C   s6   t  }d}tt| j| | jd| j|d t|j d S )Nr   r>   )r`   rK   rL   rQ   )r6   r   r    rH   r:   rL   r   r#   )r'   rQ   rU   r   r   r   test_pass_accept_test   s   z&TestBasinHopping.test_pass_accept_testc                 C   sT   t  }d}tt| j| | jd| j|d}t|j td|jd v  t	|j
d d S )Nr      )r`   rK   rL   callbackr|   r   	   )r<   r   r    rH   r:   rL   r   r#   messager   nit)r'   r|   rU   rc   r   r   r   test_pass_callback  s   
z#TestBasinHopping.test_pass_callbackc                 C   sN   d}t dd| jd< d| _tt| j| | j| j| jd}t|jd |j	 d S )Nr   r   )maxiteroptionsr>   r_   )
dictr:   rK   r   r    rH   rL   r   r   Zminimization_failuresrb   r   r   r   test_minimizer_fail  s   z$TestBasinHopping.test_minimizer_failc                 C   s$   d}t t| j| | jd| jd d S r^   )r   r   rH   r:   rL   rT   r   r   r   test_niter_zero&  s   
z TestBasinHopping.test_niter_zeroc                    st   ddd}g   fdd}t tddg|d|dd g fd	d
}t tddg|d|dd tt t d S )NrD   TrE   c                         | d S Nappendr   r   r?   )f_1r   r   r|   2     z<TestBasinHopping.test_seed_reproducibility.<locals>.callbackrA   r>   )r`   rK   r|   rM   c                    r   r   r   r   )f_2r   r   	callback2:  r   z=TestBasinHopping.test_seed_reproducibility.<locals>.callback2)r   r    r   r   r   )r'   r`   r|   r   r   )r   r   r   test_seed_reproducibility,  s   
z*TestBasinHopping.test_seed_reproducibilityz1.17z)Generator not available for numpy, < 1.17)reasonc                 C   s`   t jd}ddd}ttddg|d|d}t jd}ttddg|d|d}t|j|j d S )Nr   rD   TrE   rA   r>   )r`   rK   rM   )r   r1   Zdefault_rngr   r    r   r   )r'   rngr`   Zres1Zres2r   r   r   test_random_genA  s   


z TestBasinHopping.test_random_genc                 C   s>   d}t t| j| | j| j| jdd}t|j| j| | j	 d S )Nr   )r`   rK   rL   Tra   rb   r   r   r   test_monotonic_basin_hoppingS  s
   
z-TestBasinHopping.test_monotonic_basin_hoppingN)r+   r,   r-   rO   rV   r\   rd   rf   ri   rl   rm   rr   rt   rx   ry   rz   r   r   r   r   pytestZmarkZskipifr   r   __version__r   r   r   r   r   r   r@   j   s.    


r@   c                   @   s$   e Zd Zdd Zdd Zdd ZdS )Test_Storagec                 C   s6   t d| _d| _t }| j|_| j|_t|| _d S )Nr   r   )	r   r   rH   f0r	   r   funr
   storage)r'   minresr   r   r   rO   \  s   zTest_Storage.setup_methodc                 C   s^   t  }| jd |_| jd |_| j|}| j }t| j|j t| j|j t	|  d S Nr   )
r	   rH   r   r   r   r   update
get_lowestr   r   r'   Z
new_minresretr   r   r   r   test_higher_f_rejectedf  s   
z#Test_Storage.test_higher_f_rejectedc                 C   s`   t  }| jd |_| jd |_| j|}| j }t| j|jk t| j|jk t| d S r   )	r	   rH   r   r   r   r   r   r   r   r   r   r   r   test_lower_f_acceptedq  s   
z"Test_Storage.test_lower_f_acceptedN)r+   r,   r-   rO   r   r   r   r   r   r   r   [  s    
r   c                   @   s   e Zd Zdd Zdd ZdS )Test_RandomDisplacementc                 C   s.   d| _ t| j d| _d| _t| jg| _d S )NrA   rv   i )rv   r   displaceNr   r   rH   r&   r   r   r   rO   ~  s   z$Test_RandomDisplacement.setup_methodc                 C   sF   |  | j}d| j d d }tt|dd tt||d d S )Nr   r      rX   r   )r   rH   rv   r   r   Zmeanvar)r'   r   vr   r   r   test_random  s   z#Test_RandomDisplacement.test_randomN)r+   r,   r-   rO   r   r   r   r   r   r   }  s    r   c                   @   s<   e Zd Zdd Zdd Zdd Zdd Zd	d
 Zdd ZdS )Test_Metropolisc                 C   s   d| _ t| j | _d S )Nr   )r   r   metr&   r   r   r   rO     s   zTest_Metropolis.setup_methodc                 C   s    | j ddd}t|tsJ d S NrX   rA   f_newf_old)r   
isinstancebool)r'   r   r   r   r   test_boolean_return  s   z#Test_Metropolis.test_boolean_returnc                 C   s   t | jddd d S r   )r   r   r&   r   r   r   r     s   z%Test_Metropolis.test_lower_f_acceptedc                 C   s$   t t| jdd t t| jdd d S )NrA   )r   )r   )rR   KeyErrorr   r&   r   r   r   test_KeyError  s   zTest_Metropolis.test_KeyErrorc                 C   sR   d}d}t dD ]}|r|r n| jddd}|rd}qd}qt| t| d S )NFi  rA   r0   r   T)ranger   r   )r'   Z
one_acceptZ
one_rejectrU   r   r   r   r   test_accept  s   zTest_Metropolis.test_acceptc                 C   sF   t d}tjdd |dd W d    d S 1 sw   Y  d S )Nr   raise)Zoverr   i  )r   r   ZerrstateZaccept_reject)r'   r   r   r   r   test_GH7495  s   "zTest_Metropolis.test_GH7495N)	r+   r,   r-   rO   r   r   r   r   r   r   r   r   r   r     s    r   c                   @   s4   e Zd Zdd Zdd Zdd Zdd Zd	d
 ZdS )Test_AdaptiveStepsizec                 C   s2   d| _ t| j d| _d| _t| jd| jd| _d S )NrA   r   r0   F)rw   verboseZaccept_rate)rv   r   tsrY   r   rw   r&   r   r   r   rO     s   z"Test_AdaptiveStepsize.setup_methodc                 C   sX   d}|  | | j d t| j jD ]}|  | | j d qt| jj| jk d S )NrX   FTrw   reportr   intervalr   r   rv   r'   r   rU   r   r   r   test_adaptive_increase     

z,Test_AdaptiveStepsize.test_adaptive_increasec                 C   sX   d}|  | | j d t| j jD ]}|  | | j d qt| jj| jk  d S )NrX   TFr   r   r   r   r   test_adaptive_decrease  r   z,Test_AdaptiveStepsize.test_adaptive_decreasec                 C   sF   d}t | jjd D ]}| | | jd q
t| jj| jk d S )NrX   r   Tr   rw   r   r   r   r   rv   r   r   r   r   test_all_accepted  
   
z'Test_AdaptiveStepsize.test_all_acceptedc                 C   sF   d}t | jjd D ]}| | | jd q
t| jj| jk  d S )NrX   r   Fr   r   r   r   r   test_all_rejected  r   z'Test_AdaptiveStepsize.test_all_rejectedN)r+   r,   r-   rO   r   r   r   r   r   r   r   r   r     s    

r   )$r.   rh   Znumpy.testingr   r   r   r   r   rR   Znumpyr   r   r   Zscipy.optimizer   r	   Zscipy.optimize._basinhoppingr
   r   r   r   Zscipy._lib._pep440r   r   r   r    r!   r"   r4   r6   r<   r@   r   r   r   r   r   r   r   r   <module>   s0    		 r"*