3.1.2. Config

3.1.2.1. Class LabelType

class mod.LabelType

Selector for which type of label to use in algorithms.

String

Vertices and edges are considered to be labelled with character strings. If only first-order terms are present, then strings are generated as a serialisation of the term.

Term

Vertices and edges are considered to be labelled with first-order terms. If only strings are present, then first-order terms are generated by parsing the strings. This may result in an TermParsingError if a string can not be parsed.

3.1.2.2. Class LabelRelation

class mod.LabelRelation

Selector for which type of labelled morphism to use in an algorithm. For strings they are all defined to be equivalent to string equality.

Isomorphism

Terms are considered isomorphic when their most general unifier is a renaming.

Specialisation

A term \(t_2\) is more special than, or isomorphic to, a term \(t_1\) if there is a substitution which can be applied to :math: t_1 to make the terms equal. This relation means that the right-hand side of a comparison is the more specialised term.

Unification

Terms unify if a most general unifier (MGU) exists. The found MGU is used for substitution in some algorithms.

3.1.2.3. Class LabelSettings

class mod.LabelSettings

A group label settings commonly used together in algorithms.

__init__(self, type, relation)

Construct label settings that only uses the vertex and edge labels.

Parameters:
  • type (LabelType) – How to interpret labels.
  • relation (LabelRelation) – The relation that should hold in morphisms between two labels.
__init__(self, type, relation, stereoRelation)

Construct label settings that include both vertex and edge labels, and stereo information.

Parameters:
  • type (LabelType) – How to interpret labels.
  • relation (LabelRelation) – The relation that should hold in morphisms between two labels.
  • stereoRelation (LabelRelation) – The relation that should hold in morphisms between stereo data.
__init__(self, type, relation, withStereo, stereoRelation)

Construct label settings that includes vertex and edge labels, and stereo information depending on the given flag.

Parameters:
  • type (LabelType) – How to interpret labels.
  • relation (LabelRelation) – The relation that should hold in morphisms between two labels.
  • withStereo (bool) – A flag to specify if stereo information should be included.
  • stereoRelation (LabelRelation) – The relation that should hold in morphisms between stereo data.
type
Type:LabelType
relation
Type:LabelRelation
withStereo
Type:bool
stereoRelation
Type:LabelRelation

3.1.2.4. Class Config

class mod.Config

This class contains a range of inner classes of config settings. See the libMØD documentation.

mod.config

This variable is initialised to the return value of getConfig(), i.e., just use this instead of the method.

mod.getConfig()
Returns:the singleton Config instance used by the library.