algebraixlib.mathobjects.couplet module¶
Provide the class Couplet
; it represents a couplet.
-
algebraixlib.mathobjects.couplet.
make_couplet_unchecked
(*args)[source]¶ Factory wrapper to create a
Couplet
(unchecked version).
-
class
algebraixlib.mathobjects.couplet.
Couplet
(left, right=None, direct_load=False)[source]¶ Bases:
algebraixlib.mathobjects.mathobject.MathObject
A couplet containing a left component and a right component.
Parameters: - left – The left component of the couplet, and the default value for the
right component (see
right
). If this argument is not aMathObject
, it is converted into anAtom
. - right – (Optional) The right component of the couplet. If this argument is
not a
MathObject
, it is converted into anAtom
. If this argument is missing, the value ofleft
is used and a reflexive couplet where left and right are the same is created. - direct_load – (Optional) Set to
True
if you know that bothleft
andright
are instances ofMathObject
.
-
left
¶ Read-only property; return the left component of this instance.
-
right
¶ Read-only property; return the right component of this instance.
-
get_ground_set
() → algebraixlib.structure.Structure[source]¶ Return the ground set of the lowest-level algebra of
self
.
-
__eq__
(other)[source]¶ A value-based comparison for equality. Return
True
if type and both members match.
-
__ne__
(other)[source]¶ A value-based comparison for inequality. Return
True
if type or members don’t match.
-
__le__
(other, NotImplemented=NotImplemented)¶ Return a <= b. Computed by @total_ordering from (a < b) or (a == b).
- left – The left component of the couplet, and the default value for the
right component (see