Skip to content

Commit

Permalink
add description in GenExpr
Browse files Browse the repository at this point in the history
  • Loading branch information
bzfmuelh committed Mar 26, 2019
1 parent 851c820 commit 134ffc3
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions src/pyscipopt/expr.pxi
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,7 @@ def buildGenExprObj(expr):
else:
assert isinstance(expr, GenExpr)
return expr

##@details Polynomial expressions of variables with operator overloading. \n
#See also the @ref ExprDetails "description" in the expr.pxi.
cdef class Expr:
Expand Down Expand Up @@ -417,14 +418,15 @@ class Op:

Operator = Op()

##@details <pre> General expressions of variables with operator overloading.
#
#@note
# - this expressions are not smart enough to identify equal terms
# - in contrast to polynomial expressions, __getitem__ is not implemented
# so expr[x] will generate an error instead of returning the coefficient of x </pre>
#
#See also the @ref ExprDetails "description" in the expr.pxi.
cdef class GenExpr:
'''General expressions of variables with operator overloading.
Notes:
- this expressions are not smart enough to identify equal terms
- in contrast to polynomial expressions, __getitem__ is not implemented
so expr[x] will generate an error instead of returning the coefficient of x
'''
cdef public operatorIndex
cdef public _op
cdef public children
Expand Down

0 comments on commit 134ffc3

Please sign in to comment.