bildZddlZddlZddlmcmZddlm Z ddl m Z Gdde jZy)a, Copyright 2013 Steven Diamond Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. N)cvxtypesceZdZdZddfd ZdZdefdZddZe dZ e de fdZ e d Z defd Zdefd Zdefd Zej&dd edefdZej&dd edefdZddefdZe ej&dZdZd defdZe dZej8dZdZdZdZe dZ ddZ!xZ"S)! ConstraintaYThe base class for constraints. A constraint is an equality, inequality, or more generally a generalized inequality that is imposed upon a mathematical expression or a list of thereof. Parameters ---------- args : list A list of expression trees. constr_id : int A unique id for the constraint. returnc||_|tj|_n||_|j |t t |yN)argsluget_id constr_id_construct_dual_variablessuperr__init__)selfr r __class__s W/home/cdr/jupyterlab/.venv/lib/python3.12/site-packages/cvxpy/constraints/constraint.pyrzConstraint.__init__)sA  YY[DN&DN &&t, j$(*c"|jS)z>Returns a string showing the mathematical constraint. )namers r__str__zConstraint.__str__4syy{rcf|jjdt|jddS)z@Returns a string with information about the constraint. (r))r__name__reprr rs r__repr__zConstraint.__repr__9s+ >>22 ! -/ /rc||Dcgc]&}tj|j(c}|_ycc}wr)rvariableshapedual_variables)rr args rr z$Constraint._construct_dual_variables?s-IMN#2x002399=NNs+9c4|jdjS)z@ int : The shape of the constrained expression. r)r r rs rr zConstraint.shapeBs yy|!!!rcFt|jdjS)zW int : The maximum number of dimensions of the constrained expression. r)lenr r rs rndimzConstraint.ndimIs 499Q<%%&&rc4|jdjS)z-int : The size of the constrained expression.r)r sizers rr(zConstraint.sizePsyy|   rc$|j S)z!Is the Leaf real valued?  is_complexrs ris_realzConstraint.is_realUs??$$$rc:td|jDS)zIs the Leaf imaginary? c3<K|]}|jywr)is_imag.0r"s r z%Constraint.is_imag..]s6S3;;=6)allr rs rr/zConstraint.is_imagZs6DII666rc:td|jDS)z$Is the Leaf complex valued? c3<K|]}|jywrr*r0s rr2z(Constraint.is_complex..bs93>>#9r3)anyr rs rr+zConstraint.is_complex_s9tyy999rdppct)zChecks whether the constraint is DCP. Returns ------- bool True if the constraint is DCP, False otherwise. NotImplementedErrorrr8s ris_dcpzConstraint.is_dcpd "##rct)zChecks whether the constraint is DGP. Returns ------- bool True if the constraint is DGP, False otherwise. r:r<s ris_dgpzConstraint.is_dgpor>rc|jdk(r|jdS|jdk(r|jdStd|)NdcpT)r8dgpzUnsupported context )lowerr=r@ ValueError)rcontexts ris_dppzConstraint.is_dppzsN ==?e #;;4;( ( ]]_ %;;4;( (3W= =rct)zThe residual of the constraint. Returns ------- NumPy.ndarray The residual, or None if the constrained expression does not have a value. r:rs rresidualzConstraint.residuals "##rc8|j}| td|S)aThe numeric residual of the constraint. The violation is defined as the distance between the constrained expression's value and its projection onto the domain of the constraint: .. math:: ||\Pi(v) - v||_2 where :math:`v` is the value of the constrained expression and :math:`\Pi` is the projection operator onto the constraint's domain . Returns ------- NumPy.ndarray The residual value. Raises ------ ValueError If the constrained expression does not have a value associated with it. zNCannot compute the violation of an constraint whose expression is None-valued.)rIrE)rrIs r violationzConstraint.violations-2==  @A Ar tolerancecd|j}| tdtj||kS)aChecks whether the constraint violation is less than a tolerance. Parameters ---------- tolerance : float The absolute tolerance to impose on the violation. Returns ------- bool True if the violation is less than ``tolerance``, False otherwise. Raises ------ ValueError If the constrained expression does not have a value associated with it. zJCannot compute the value of an constraint whose expression is None-valued.)rIrEnpr4)rrLrIs rvaluezConstraint.values<(==  @A Avvh)+,,rc|jS)z2Wrapper for compatibility with variables. r rs ridz Constraint.ids~~rc||_yrrQrrOs rrRz Constraint.ids rc|jgS)zData needed to copy. )rRrs rget_datazConstraint.get_datasyrctd)z4Raises an error due to chained constraints. zXCannot evaluate the truth value of a constraint or chain constraints, e.g., 1 >= x >= 0.) Exceptionrs r_chain_constraintszConstraint._chain_constraintss5  rc"|jS)zRaises an exception when called. Python 3 version. Called when evaluating the truth value of the constraint. Raising an error here prevents writing chained constraints. )rYrs r__bool__zConstraint.__bool__s&&((rc||jDcgc]}|j}}t|dk(r|dS|Scc}w)z8NumPy.ndarray : The value of the dual variable. r)r!rOr%)rdv dual_valss r dual_valuezConstraint.dual_valuesB)-(;(;<"RXX< < y>Q Q<   =s9c@|jdj|y)zSave the value of the dual variable for the constraint's parent. Args: value: The value of the dual variable. rN)r! save_valuerTs rsave_dual_valuezConstraint.save_dual_values A))%0rr)rN)F)rB)g:0yE>)#r __module__ __qualname____doc__rrstrrr propertyr intr&r(boolr,r/r+abcabstractmethodr=r@rGrIrKfloatrOrRsetterrVrYr[r`rc __classcell__)rs@rrrsn  + /#/ O"" 'c'' !!%% 77 :D:  $$$4$$ $$$4$$>t> $ $>-u-4 YY  )1rr)rfrknumpyrNcvxpy.lin_ops.lin_utilslin_ops lin_utilsr cvxpy.utilities utilitiesucvxpy.expressionsr Canonicalrrrrzs0  $$&`1`1r