docplex.mp.basic module

class docplex.mp.basic.Expr

Bases: docplex.mp.basic.ModelingObjectBase, docplex.mp.operand.Operand

Parent class for all expression classes.

contains_var(dvar)

Checks whether a variable is present in the expression.

Param:dvar (docplex.mp.linear.Var): A decision variable. Returns:True if the variable is present in the expression, else False. Return type:Boolean

is_quad_expr()

Returns True if the expression is quadratic

number_of_variables()

Returns:The number of variables in the expression. Return type:integer

class docplex.mp.basic.IndexableObject(model, name=None, index=-2)

Bases: docplex.mp.basic.ModelingObjectBase

is_generated()

Checks whether this object has been generated by another modeling object.

If so, the origin object is stored in the _origin attribute.

Returns:True if the objects has been generated.

class docplex.mp.basic.ModelingObjectBase

Bases: object

Parent class for all modeling objects (variables and constraints).

This class is not intended to be instantiated directly.

has_name()

Checks whether the object has a name.

Returns:True if the object has a name.

has_user_name()

Checks whether the object has a valid name given by the user.

Returns:True if the object has a valid name given by the user.

model

This property returns the docplex.mp.model.Model to which the object belongs.

name

This property is used to get or set the name of the modeling object.

class docplex.mp.basic.Priority

Bases: enum.Enum

This enumerated class defines the priorities: VERY_LOW, LOW, MEDIUM, HIGH, VERY_HIGH, MANDATORY.