o
    Ö­jøB  ã                   @   s¢   d Z ddlZddlZddlmZmZ ddlmZ ddl	m
Z
 ddlmZmZmZmZmZ ddlmZmZmZ d	d
„ Zdd„ Zdd„ Z								ddd„ZdS )a^  HiGHS Linear Optimization Methods

Interface to HiGHS linear optimization software.
https://highs.dev/

.. versionadded:: 1.5.0

References
----------
.. [1] Q. Huangfu and J.A.J. Hall. "Parallelizing the dual revised simplex
           method." Mathematical Programming Computation, 10 (1), 119-142,
           2018. DOI: 10.1007/s12532-017-0130-5

é    Né   )ÚOptimizeWarningÚOptimizeResult)Úwarn)Ú_highs_wrapper)Ú	kHighsInfÚHighsDebugLevelÚObjSenseÚHighsModelStatusÚsimplex_constants)Ú
csc_matrixÚvstackÚissparsec                 C   sÈ   i dd“t jd“t jd“t jd“t jd“t jd“t jd“t jd“t jd“t j	d“t j
d“t jd“t jd“t jd“t jd	“t jd
“}d}| | |¡\}}| durSt| ƒnd}|› d|› d|› d�}||fS )zCConverts HiGHS status number/message to SciPy status number/messageN)é   z%HiGHS did not provide a status code. )r   Ú )é   r   )r   z&Optimization terminated successfully. )r   zTime limit reached. )r   zIteration limit reached. )r   zThe problem is infeasible. )é   zThe problem is unbounded. )r   z(The problem is unbounded or infeasible. )r   z*The HiGHS status code was not recognized. z(HiGHS Status z: ú))r
   ÚkNotsetÚ
kLoadErrorÚkModelErrorÚkPresolveErrorÚkSolveErrorÚkPostsolveErrorÚkModelEmptyÚkObjectiveBoundÚkObjectiveTargetÚkOptimalÚ
kTimeLimitÚkIterationLimitÚkInfeasibleÚ
kUnboundedÚkUnboundedOrInfeasibleÚgetÚint)Úhighs_statusÚhighs_messageÚscipy_statuses_messagesÚunrecognizedÚscipy_statusÚscipy_messageÚhstat© r,   úZ/var/www/html/CropPilot/venv/lib/python3.10/site-packages/scipy/optimize/_linprog_highs.pyÚ_highs_to_scipy_status_message"   sV   ÿþýüûúùø	÷
öõôóòñð
ÿÿÿr.   c                 C   sR   t  | ¡}t jdd�� t  | | ¡t | |< W d   ƒ | S 1 s"w   Y  | S )NÚignore©Úinvalid)ÚnpÚisinfÚerrstateÚsignr   )ÚxÚinfsr,   r,   r-   Ú_replace_inf@   s   

ÿþr8   c                 C   sˆ   z||   ¡  W S  ty   ||   Y S  tyC   t t¡}|j| j}td|› d| › dt	| 
¡ ƒ› d|› d�	tdd� ||  Y S w )NzOption z is z, but only values in z are allowed. Using default: Ú.r   ©Ú
stacklevel)ÚlowerÚAttributeErrorÚKeyErrorÚinspectÚ	signatureÚ_linprog_highsÚ
parametersÚdefaultr   ÚsetÚkeysr   )ÚoptionÚ
option_strÚchoicesÚsigÚdefault_strr,   r,   r-   Ú_convert_to_highs_enumH   s    

ÿþýùrK   TFc           .      K   sÄ  |rd|› d�}t |tdd� t|	dtjjtjjtjjtjjddœd�}| \}}}}}}}}|j	 
¡ \}}tjd	d
�� t |¡ tj }W d  ƒ n1 sOw   Y  |}|}|}t ||f¡}t ||f¡}t|ƒspt|ƒrwt||fƒ}nt ||f¡}t|ƒ}i d|“dtj“d|“d|“dtj“d|“d|“d|“d|“d|“d|“d|“dtjj“d|“d|“d|
“} |  |¡ t|ƒ}t|ƒ}t|ƒ}t|ƒ}|du sØt |¡dkrÞt d¡}nt |¡}t||j|j |j!||||| "tj#¡| ƒ
}!d|!v �r|!d }"t |"t$|ƒd… ¡}#t |"dt$|ƒ… ¡}"nd\}"}#d|!v �rU|!d }$t |$dt$|ƒ… ¡}%t |$t$|ƒd… ¡}&t |!d ddd…f ¡}'t |!d ddd…f ¡}(nd\}%}&d\}'}(|! %d d¡})|! %d!d¡}*t&|)|*ƒ\}+}|!d" },|,|"|#t'|"|%d#œƒt'|#|&d#œƒt'|,du �r‹dn|,| |(d#œƒt'|,du �ršdn||, |'d#œƒ|! %d$¡|+|!d  t(j)k||! %d%d¡�p¹|! %d&d¡|! %d'¡d(œ}-t *|,¡�rà|du�rà|- |! %d)d¡|! %d*d+¡|! %d,d+¡d-œ¡ |-S ).aý  
    Solve the following linear programming problem using one of the HiGHS
    solvers:

    User-facing documentation is in _linprog_doc.py.

    Parameters
    ----------
    lp :  _LPProblem
        A ``scipy.optimize._linprog_util._LPProblem`` ``namedtuple``.
    solver : "ipm" or "simplex" or None
        Which HiGHS solver to use.  If ``None``, "simplex" will be used.

    Options
    -------
    maxiter : int
        The maximum number of iterations to perform in either phase. For
        ``solver='ipm'``, this does not include the number of crossover
        iterations.  Default is the largest possible value for an ``int``
        on the platform.
    disp : bool
        Set to ``True`` if indicators of optimization status are to be printed
        to the console each iteration; default ``False``.
    time_limit : float
        The maximum time in seconds allotted to solve the problem; default is
        the largest possible value for a ``double`` on the platform.
    presolve : bool
        Presolve attempts to identify trivial infeasibilities,
        identify trivial unboundedness, and simplify the problem before
        sending it to the main solver. It is generally recommended
        to keep the default setting ``True``; set to ``False`` if presolve is
        to be disabled.
    dual_feasibility_tolerance : double
        Dual feasibility tolerance.  Default is 1e-07.
        The minimum of this and ``primal_feasibility_tolerance``
        is used for the feasibility tolerance when ``solver='ipm'``.
    primal_feasibility_tolerance : double
        Primal feasibility tolerance.  Default is 1e-07.
        The minimum of this and ``dual_feasibility_tolerance``
        is used for the feasibility tolerance when ``solver='ipm'``.
    ipm_optimality_tolerance : double
        Optimality tolerance for ``solver='ipm'``.  Default is 1e-08.
        Minimum possible value is 1e-12 and must be smaller than the largest
        possible value for a ``double`` on the platform.
    simplex_dual_edge_weight_strategy : str (default: None)
        Strategy for simplex dual edge weights. The default, ``None``,
        automatically selects one of the following.

        ``'dantzig'`` uses Dantzig's original strategy of choosing the most
        negative reduced cost.

        ``'devex'`` uses the strategy described in [15]_.

        ``steepest`` uses the exact steepest edge strategy as described in
        [16]_.

        ``'steepest-devex'`` begins with the exact steepest edge strategy
        until the computation is too costly or inexact and then switches to
        the devex method.

        Currently, using ``None`` always selects ``'steepest-devex'``, but this
        may change as new options become available.

    mip_max_nodes : int
        The maximum number of nodes allotted to solve the problem; default is
        the largest possible value for a ``HighsInt`` on the platform.
        Ignored if not using the MIP solver.
    unknown_options : dict
        Optional arguments not used by this particular solver. If
        ``unknown_options`` is non-empty, a warning is issued listing all
        unused options.

    Returns
    -------
    sol : dict
        A dictionary consisting of the fields:

            x : 1D array
                The values of the decision variables that minimizes the
                objective function while satisfying the constraints.
            fun : float
                The optimal value of the objective function ``c @ x``.
            slack : 1D array
                The (nominally positive) values of the slack,
                ``b_ub - A_ub @ x``.
            con : 1D array
                The (nominally zero) residuals of the equality constraints,
                ``b_eq - A_eq @ x``.
            success : bool
                ``True`` when the algorithm succeeds in finding an optimal
                solution.
            status : int
                An integer representing the exit status of the algorithm.

                ``0`` : Optimization terminated successfully.

                ``1`` : Iteration or time limit reached.

                ``2`` : Problem appears to be infeasible.

                ``3`` : Problem appears to be unbounded.

                ``4`` : The HiGHS solver ran into a problem.

            message : str
                A string descriptor of the exit status of the algorithm.
            nit : int
                The total number of iterations performed.
                For ``solver='simplex'``, this includes iterations in all
                phases. For ``solver='ipm'``, this does not include
                crossover iterations.
            crossover_nit : int
                The number of primal/dual pushes performed during the
                crossover routine for ``solver='ipm'``.  This is ``0``
                for ``solver='simplex'``.
            ineqlin : OptimizeResult
                Solution and sensitivity information corresponding to the
                inequality constraints, `b_ub`. A dictionary consisting of the
                fields:

                residual : np.ndnarray
                    The (nominally positive) values of the slack variables,
                    ``b_ub - A_ub @ x``.  This quantity is also commonly
                    referred to as "slack".

                marginals : np.ndarray
                    The sensitivity (partial derivative) of the objective
                    function with respect to the right-hand side of the
                    inequality constraints, `b_ub`.

            eqlin : OptimizeResult
                Solution and sensitivity information corresponding to the
                equality constraints, `b_eq`.  A dictionary consisting of the
                fields:

                residual : np.ndarray
                    The (nominally zero) residuals of the equality constraints,
                    ``b_eq - A_eq @ x``.

                marginals : np.ndarray
                    The sensitivity (partial derivative) of the objective
                    function with respect to the right-hand side of the
                    equality constraints, `b_eq`.

            lower, upper : OptimizeResult
                Solution and sensitivity information corresponding to the
                lower and upper bounds on decision variables, `bounds`.

                residual : np.ndarray
                    The (nominally positive) values of the quantity
                    ``x - lb`` (lower) or ``ub - x`` (upper).

                marginals : np.ndarray
                    The sensitivity (partial derivative) of the objective
                    function with respect to the lower and upper
                    `bounds`.

            mip_node_count : int
                The number of subproblems or "nodes" solved by the MILP
                solver. Only present when `integrality` is not `None`.

            mip_dual_bound : float
                The MILP solver's final estimate of the lower bound on the
                optimal solution. Only present when `integrality` is not
                `None`.

            mip_gap : float
                The difference between the final objective function value
                and the final dual bound, scaled by the final objective
                function value. Only present when `integrality` is not
                `None`.

    Notes
    -----
    The result fields `ineqlin`, `eqlin`, `lower`, and `upper` all contain
    `marginals`, or partial derivatives of the objective function with respect
    to the right-hand side of each constraint. These partial derivatives are
    also referred to as "Lagrange multipliers", "dual values", and
    "shadow prices". The sign convention of `marginals` is opposite that
    of Lagrange multipliers produced by many nonlinear solvers.

    References
    ----------
    .. [15] Harris, Paula MJ. "Pivot selection methods of the Devex LP code."
            Mathematical programming 5.1 (1973): 1-28.
    .. [16] Goldfarb, Donald, and John Ker Reid. "A practicable steepest-edge
            simplex algorithm." Mathematical Programming 12.1 (1977): 361-371.
    zUnrecognized options detected: z). These will be passed to HiGHS verbatim.r   r:   Ú!simplex_dual_edge_weight_strategyN)ÚdantzigÚdevexzsteepest-devexÚsteepestN)rH   r/   r0   ÚpresolveÚsenseÚsolverÚ
time_limitÚhighs_debug_levelÚdual_feasibility_toleranceÚipm_optimality_toleranceÚlog_to_consoleÚmip_max_nodesÚoutput_flagÚprimal_feasibility_toleranceÚsimplex_strategyÚipm_iteration_limitÚsimplex_iteration_limitÚmip_rel_gapr   Úslack)NNÚlambdaÚ	marg_bndsr   ÚstatusÚmessager6   )ÚresidualÚ	marginalsÚfunÚsimplex_nitÚipm_nitÚcrossover_nit)r6   r_   ÚconÚineqlinÚeqlinr<   Úupperrf   rb   Úsuccessrc   Únitri   Úmip_node_countÚmip_dual_boundg        Úmip_gap)rp   rq   rr   )+r   r   rK   Ús_cÚSimplexEdgeWeightStrategyÚ!kSimplexEdgeWeightStrategyDantzigÚkSimplexEdgeWeightStrategyDevexÚ kSimplexEdgeWeightStrategyChooseÚ&kSimplexEdgeWeightStrategySteepestEdgeÚTÚcopyr2   r4   Ú	ones_likeÚinfÚconcatenater   r   r   r	   Ú	kMinimizer   ÚkHighsDebugLevelNoneÚSimplexStrategyÚkSimplexStrategyDualÚupdater8   ÚsumÚemptyÚarrayr   ÚindptrÚindicesÚdataÚastypeÚuint8Úlenr#   r.   r   r
   r   Úany).ÚlprR   rS   rP   ÚdispÚmaxiterrU   rZ   rV   rL   r^   rX   Úunknown_optionsrc   Ú&simplex_dual_edge_weight_strategy_enumÚcÚA_ubÚb_ubÚA_eqÚb_eqÚboundsÚx0ÚintegralityÚlbÚubÚlhs_ubÚrhs_ubÚlhs_eqÚrhs_eqÚlhsÚrhsÚAÚoptionsÚresr_   rj   ÚlamdaÚmarg_ineqlinÚ
marg_eqlinÚ
marg_upperÚ
marg_lowerr%   r&   rb   r6   Úsolr,   r,   r-   rA   Y   sú    Føýÿÿþýüûúùø	÷
öõóòñðï

ÿ

ÿþþþþè


ýrA   )
NTFNNNNNNN)Ú__doc__r?   Únumpyr2   Ú	_optimizer   r   Úwarningsr   Ú_highspy._highs_wrapperr   Ú_highspy._corer   r   r	   r
   r   rs   Úscipy.sparser   r   r   r.   r8   rK   rA   r,   r,   r,   r-   Ú<module>   s(    ù