3.1.15. RuleGraphInterface

3.1.15.1. Class RuleLeftGraph

class mod.RuleLeftGraph

A proxy object representing the left graph of the rule.

rule

(Read-only) The rule the graph belongs to.

Type:Rule
numVertices

(Read-only) The number of vertices in the graph.

Type:int
vertices

(Read-only) An iterable of all vertices in the graph.

Type:RuleLeftGraphVertexRange
numEdges

(Read-only) The number of edges in the graph.

Type:int
edges

(Read-only) An iterable of all edges in the graph.

Type:RuleLeftGraphEdgeRange

3.1.15.2. Class RuleLeftGraphVertex

class mod.RuleLeftGraphVertex

A descriptor of either a vertex in a left side, or a null vertex.

__init__(self)

Constructs a null descriptor.

isNull()
Returns:whether this is a null descriptor or not.
Return type:bool
id

(Read-only) The index of the vertex. It will be in the range \([0, numCoreVertices[\).

Type:int
Raises:LogicError if it is a null descriptor.
rule

(Read-only) The rule the vertex belongs to.

Type:Rule
Raises:LogicError if it is a null descriptor.
core

(Read-only) The descriptor for this vertex in the core graph.

Type:RuleVertex
degree

(Read-only) The degree of the vertex.

Type:int
Raises:LogicError if it is a null descriptor.
incidentEdges

(Read-only) A range of incident edges to this vertex.

Type:RuleLeftGraphIncidentEdgeRange
Raises:LogicError if it is a null descriptor.
stringLabel

(Read-only) The string label of the vertex.

Type:string
Raises:LogicError if it is a null descriptor.
atomId

(Read-only) The atom id of the vertex.

Type:AtomId
Raises:LogicError if it is a null descriptor.
charge

(Read-only) The charge of the vertex.

Type:Charge
Raises:LogicError if it is a null descriptor.
radical

(Read-only) The radical status of the vertex.

Type:bool
Raises:LogicError if it is a null descriptor.

3.1.15.3. Class RuleLeftGraphEdge

class mod.RuleLeftGraphEdge

A descriptor of either an edge in a left side, or a null edge.

__init__(self)

Constructs a null descriptor.

isNull()
Returns:whether this is a null descriptor or not.
Return type:bool
graph

(Read-only) The rule the edge belongs to.

Type:Rule
Raises:LogicError if it is a null descriptor.
core

(Read-only) The descriptor for this edge in the core graph.

Type:RuleEdge
source

(Read-only) The source vertex of the edge.

Type:RuleLeftGraphVertex
Raises:LogicError if it is a null descriptor.
target

(Read-only) The target vertex of the edge.

Type:RuleLeftGraphVertex
Raises:LogicError if it is a null descriptor.
stringLabel

(Read-only) The string label of the edge.

Type:string
Raises:LogicError if it is a null descriptor.
bondType

(Read-only) The bond type of the edge.

Type:BondType
Raises:LogicError if it is a null descriptor.

3.1.15.4. Class RuleContextGraph

class mod.RuleContextGraph

A proxy object representing the context graph of the rule.

rule

(Read-only) The rule the graph belongs to.

Type:Rule
numVertices

(Read-only) The number of vertices in the graph.

Type:int
vertices

(Read-only) An iterable of all vertices in the graph.

Type:RuleContextGraphVertexRange
numEdges

(Read-only) The number of edges in the graph.

Type:int
edges

(Read-only) An iterable of all edges in the graph.

Type:RuleContextGraphEdgeRange

3.1.15.5. Class RuleLeftGraphVertex

class mod.RuleLeftGraphVertex

A descriptor of either a vertex in a context, or a null vertex.

__init__(self)

Constructs a null descriptor.

isNull()
Returns:whether this is a null descriptor or not.
Return type:bool
id

(Read-only) The index of the vertex. It will be in the range \([0, numCoreVertices[\).

Type:int
Raises:LogicError if it is a null descriptor.
rule

(Read-only) The rule the vertex belongs to.

Type:Rule
Raises:LogicError if it is a null descriptor.
core

(Read-only) The descriptor for this vertex in the core graph.

Type:RuleVertex
degree

(Read-only) The degree of the vertex.

Type:int
Raises:LogicError if it is a null descriptor.
incidentEdges

(Read-only) A range of incident edges to this vertex.

Type:RuleContextGraphIncidentEdgeRange
Raises:LogicError if it is a null descriptor.

3.1.15.6. Class RuleContextGraphEdge

class mod.RuleContextGraphEdge

A descriptor of either an edge in a context, or a null edge.

__init__(self)

Constructs a null descriptor.

isNull()
Returns:whether this is a null descriptor or not.
Return type:bool
graph

(Read-only) The rule the edge belongs to.

Type:Rule
Raises:LogicError if it is a null descriptor.
core

(Read-only) The descriptor for this edge in the core graph.

Type:RuleEdge
source

(Read-only) The source vertex of the edge.

Type:RuleContextGraphVertex
Raises:LogicError if it is a null descriptor.
target

(Read-only) The target vertex of the edge.

Type:RuleContextGraphVertex
Raises:LogicError if it is a null descriptor.

3.1.15.7. Class RuleRightGraph

class mod.RuleRightGraph

A proxy object representing the right graph of the rule.

rule

(Read-only) The rule the graph belongs to.

Type:Rule
numVertices

(Read-only) The number of vertices in the graph.

Type:int
vertices

(Read-only) An iterable of all vertices in the graph.

Type:RuleRightGraphVertexRange
numEdges

(Read-only) The number of edges in the graph.

Type:int
edges

(Read-only) An iterable of all edges in the graph.

Type:RuleRightGraphEdgeRange

3.1.15.8. Class RuleRightGraphVertex

class mod.RuleRightGraphVertex

A descriptor of either a vertex in a right side, or a null vertex.

__init__(self)

Constructs a null descriptor.

isNull()
Returns:whether this is a null descriptor or not.
Return type:bool
id

(Read-only) The index of the vertex. It will be in the range \([0, numCoreVertices[\).

Type:int
Raises:LogicError if it is a null descriptor.
rule

(Read-only) The rule the vertex belongs to.

Type:Rule
Raises:LogicError if it is a null descriptor.
core

(Read-only) The descriptor for this vertex in the core graph.

Type:RuleVertex
degree

(Read-only) The degree of the vertex.

Type:int
Raises:LogicError if it is a null descriptor.
incidentEdges

(Read-only) A range of incident edges to this vertex.

Type:RuleRightGraphIncidentEdgeRange
Raises:LogicError if it is a null descriptor.
stringLabel

(Read-only) The string label of the vertex.

Type:string
Raises:LogicError if it is a null descriptor.
atomId

(Read-only) The atom id of the vertex.

Type:AtomId
Raises:LogicError if it is a null descriptor.
charge

(Read-only) The charge of the vertex.

Type:Charge
Raises:LogicError if it is a null descriptor.
radical

(Read-only) The radical status of the vertex.

Type:bool
Raises:LogicError if it is a null descriptor.

3.1.15.9. Class RuleRightGraphEdge

class mod.RuleRightGraphEdge

A descriptor of either an edge in a right side, or a null edge.

__init__(self)

Constructs a null descriptor.

isNull()
Returns:whether this is a null descriptor or not.
Return type:bool
graph

(Read-only) The rule the edge belongs to.

Type:Rule
Raises:LogicError if it is a null descriptor.
core

(Read-only) The descriptor for this edge in the core graph.

Type:RuleEdge
source

(Read-only) The source vertex of the edge.

Type:RuleRightGraphVertex
Raises:LogicError if it is a null descriptor.
target

(Read-only) The target vertex of the edge.

Type:RuleRightGraphVertex
Raises:LogicError if it is a null descriptor.
stringLabel

(Read-only) The string label of the edge.

Type:string
Raises:LogicError if it is a null descriptor.
bondType

(Read-only) The bond type of the edge.

Type:BondType
Raises:LogicError if it is a null descriptor.

3.1.15.10. Class RuleVertex

class mod.RuleVertex

A descriptor of either a vertex in a rule, or a null vertex.

__init__(self)

Constructs a null descriptor.

isNull()
Returns:whether this is a null descriptor or not.
Return type:bool
id

(Read-only) The index of the vertex. It will be in the range \([0, numVertices[\).

Type:int
Raises:LogicError if it is a null descriptor.
rule

(Read-only) The rule the vertex belongs to.

Type:Rule
Raises:LogicError if it is a null descriptor.
left

(Read-only) A null descriptor if this vertex is not in the left graph, otherwise the descriptor of this vertex in the left graph.

context

(Read-only) A null descriptor if this vertex is not in the context graph, otherwise the descriptor of this vertex in the context graph.

left

(Read-only) A null descriptor if this vertex is not in the right graph, otherwise the descriptor of this vertex in the right graph.

degree

(Read-only) The degree of the vertex.

Type:int
Raises:LogicError if it is a null descriptor.
incidentEdges

(Read-only) A range of incident edges to this vertex.

Type:RuleIncidentEdgeRange
Raises:LogicError if it is a null descriptor.

3.1.15.11. Class RuleEdge

class mod.RuleEdge

A descriptor of either an edge in a rule, or a null edge.

__init__(self)

Constructs a null descriptor.

isNull()
Returns:whether this is a null descriptor or not.
Return type:bool
rule

(Read-only) The rule the edge belongs to.

Type:Rule
Raises:LogicError if it is a null descriptor.
left

(Read-only) A null descriptor if this edge is not in the left graph, otherwise the descriptor of this edge in the left graph.

context

(Read-only) A null descriptor if this edge is not in the context graph, otherwise the descriptor of this edge in the context graph.

left

(Read-only) A null descriptor if this edge is not in the right graph, otherwise the descriptor of this edge in the right graph.

source

(Read-only) The source vertex of the edge.

Type:RuleVertex
Raises:LogicError if it is a null descriptor.
target

(Read-only) The target vertex of the edge.

Type:RuleVertex
Raises:LogicError if it is a null descriptor.