working: refactorize gedlibpy module.

Author: jajupmochi

gklearn/gedlib/bind_errors.py

@@ -0,0 +1,76 @@
+"""
+bind_errors
+
+
+
+@Author: jajupmochi
+@Date: May 31 2025
+"""
+
+
+#####################
+##ERRORS MANAGEMENT##
+#####################
+
+class Error(Exception):
+	"""
+		Class for error's management. This one is general.
+	"""
+	pass
+
+
+class EditCostError(Error):
+	"""
+		Class for Edit Cost Error. Raise an error if an edit cost function doesn't exist in the library (not in list_of_edit_cost_options).
+
+		:attribute message: The message to print when an error is detected.
+		:type message: string
+	"""
+
+
+	def __init__(self, message):
+		"""
+			Inits the error with its message.
+
+			:param message: The message to print when the error is detected
+			:type message: string
+		"""
+		self.message = message
+
+
+class MethodError(Error):
+	"""
+		Class for Method Error. Raise an error if a computation method doesn't exist in the library (not in list_of_method_options).
+
+		:attribute message: The message to print when an error is detected.
+		:type message: string
+	"""
+
+
+	def __init__(self, message):
+		"""
+			Inits the error with its message.
+
+			:param message: The message to print when the error is detected
+			:type message: string
+		"""
+		self.message = message
+
+
+class InitError(Error):
+	"""
+		Class for Init Error. Raise an error if an init option doesn't exist in the library (not in list_of_init_options).
+
+		:attribute message: The message to print when an error is detected.
+		:type message: string
+	"""
+
+
+	def __init__(self, message):
+		"""
+			Inits the error with its message.
+
+			:param message: The message to print when the error is detected
+			:type message: string
+		"""
+		self.message = message

gklearn/gedlib/common_bind.pxd

@@ -0,0 +1,36 @@
+# distutils: language = c++
+
+"""
+	Python GedLib module for the common definition bindings
+	======================
+
+	This module allows using a C++ library for edit distance between graphs (GedLib) with Python.
+
+
+	Authors
+	-------------------
+	Linlin Jia
+	David Blumenthal
+	Natacha Lambert
+
+	Copyright (C) 2019-2025 by all the authors
+
+	Classes & Functions
+	-------------------
+
+"""
+
+from libcpp.vector cimport vector
+from libcpp.string cimport string
+
+
+#################################
+##DECLARATION OF C++ INTERFACES##
+#################################
+
+
+cdef extern from "src/gedlib_bind.hpp" namespace "pyged":
+	cdef vector[string] getEditCostStringOptions() except +
+	cdef vector[string] getMethodStringOptions() except +
+	cdef vector[string] getInitStringOptions() except +
+	cdef size_t getDummyNode() except +

gklearn/gedlib/common_bind.pyx

@@ -0,0 +1,86 @@
+# distutils: language = c++
+
+"""
+	Python GedLib module for the common definition bindings
+	======================
+
+	This module allows using a C++ library for edit distance between graphs (GedLib) with Python.
+
+
+	Authors
+	-------------------
+	Linlin Jia
+	David Blumenthal
+	Natacha Lambert
+
+	Copyright (C) 2019-2025 by all the authors
+
+	Classes & Functions
+	-------------------
+
+"""
+
+#############################
+##CYTHON WRAPPER INTERFACES##
+#############################
+
+
+def get_edit_cost_options():
+	"""
+		Searchs the differents edit cost functions and returns the result.
+
+		:return: The list of edit cost functions
+		:rtype: list[string]
+
+		.. warning:: This function is useless for an external use. Please use directly list_of_edit_cost_options.
+		.. note:: Prefer the list_of_edit_cost_options attribute of this module.
+	"""
+
+	return [option.decode('utf-8') for option in getEditCostStringOptions()]
+
+
+def get_method_options():
+	"""
+		Searchs the differents method for edit distance computation between graphs and returns the result.
+
+		:return: The list of method to compute the edit distance between graphs
+		:rtype: list[string]
+
+		.. warning:: This function is useless for an external use. Please use directly list_of_method_options.
+		.. note:: Prefer the list_of_method_options attribute of this module.
+	"""
+	return [option.decode('utf-8') for option in getMethodStringOptions()]
+
+
+def get_init_options():
+	"""
+		Searchs the differents initialization parameters for the environment computation for graphs and returns the result.
+
+		:return: The list of options to initialize the computation environment
+		:rtype: list[string]
+
+		.. warning:: This function is useless for an external use. Please use directly list_of_init_options.
+		.. note:: Prefer the list_of_init_options attribute of this module.
+	"""
+	return [option.decode('utf-8') for option in getInitStringOptions()]
+
+
+def get_dummy_node():
+	"""
+		Returns the ID of a dummy node.
+
+		:return: The ID of the dummy node (18446744073709551614 for my computer, the hugest number possible)
+		:rtype: size_t
+
+		.. note:: A dummy node is used when a node isn't associated to an other node.
+	"""
+	return getDummyNode()
+
+
+#####################################################################
+##LISTS OF EDIT COST FUNCTIONS, METHOD COMPUTATION AND INIT OPTIONS##
+#####################################################################
+
+list_of_edit_cost_options = get_edit_cost_options()
+list_of_method_options = get_method_options()
+list_of_init_options = get_init_options()

gklearn/gedlib/gedlibpy.py

@@ -0,0 +1,53 @@
+"""
+gedlibpy
+
+Helper for GEDLIBPY Python bindings.
+
+@Author: jajupmochi
+@Date: May 31 2025
+"""
+from gedlibpy_gxl import GEDEnvGXL
+from gedlibpy_attr import GEDEnvAttr
+
+
+def GEDEnv(env_type='attr'):
+    """
+    A factory function that returns the appropriate GED environment.
+
+    This function provides a unified interface for different GED environments, such as GXL
+    and attribute-based graphs.
+    The specific environment will be selected based on the provided parameter `env_type`.
+
+    Parameters
+    ----------
+    env_type : str
+        The type of the GED environment to initialize. Options are 'gxl', 'str', or 'attr'.
+        'gxl' and 'str' initialize a GXL-based environment, where node and edge labels are strings.
+        The default is 'attr', which initializes an attribute-based environment,
+        where node and edge labels can be dictionaries with string keys and values of
+        various types (namely, string, int, float, list/np.array of strings,
+        and list/np.array of integers, and list/np.array of floats).
+
+    Returns
+    -------
+    ged_env : GEDEnvGXL or GEDEnvAttr
+        An instance of the appropriate GED environment class based on the specified type.
+
+    Raises
+    ------
+    ValueError
+        If the provided `env_type` is not recognized (not 'gxl', 'str', or 'attr').
+    """
+    env_type = env_type.lower()
+    if env_type in ['gxl', 'str']:
+        return GEDEnvGXL()
+    elif env_type == 'attr':
+        return GEDEnvAttr()
+    else:
+        raise ValueError(
+            f'Unknown environment type: {env_type}. Please use "gxl", "str", or "attr".'
+            f'"gxl" and "str" are equivalent and use string labels for nodes and edges, '
+            f'while "attr" uses attribute-based labels with dictionaries with string '
+            f'keys and values of various types, namely, string, int, float, '
+            f'list/np.array of strings, list/np.array of integers, and list/np.array of floats.'
+        )