Module fcmpy.simulator.transfer
Expand source code
import numpy as np
from abc import ABC, abstractmethod
class Transfer(ABC):
"""
Class of FCM transfer methods.
"""
@abstractmethod
def transfer() -> np.array:
raise NotImplementedError('Transfer method is not defined!')
class Sigmoid(Transfer):
"""
Sigmoid transfer method
"""
@staticmethod
def transfer(**kwargs) -> np.array:
"""
Sigmoid transfer function.
Parameters
----------
x : numpy.array,
the results of the FCM update function.
l : int/float
A parameter that determines the steepness of the sigmoid function at values around 0.
Return
-------
y : numpy.array,
domain R,
range [0,1].
"""
x = kwargs['x']
l = kwargs['params']['l']
e = np.exp(1)
res = 1/(1+(e**(-l*x)))
return res
class Bivalent(Transfer):
"""
Bivalent transfer method
"""
@staticmethod
def transfer(**kwargs) -> np.array:
"""
Bivalent transfer function.
Parameters
----------
x : numpy.array,
the results of the FCM update function.
Return
-------
y : numpy.array,
domain R,
range [0;1].
"""
x = kwargs['x']
res = np.array([1 if i > 0 else 0 for i in x])
return res
class Trivalent(Transfer):
"""
Trivalent transfer function.
"""
@staticmethod
def transfer(**kwargs) -> np.array:
"""
Trivalent transfer function.
Parameters
----------
x : numpy.array,
the results of the FCM update function.
Return
----------
y : numpy.array,
domain R,
range [-1,0,1].
"""
x = kwargs['x']
res = np.array([1 if i > 0 else -1 if i < 0 else 0 for i in x])
return res
class HyperbolicTangent(Transfer):
"""
Hyperbolic tangent transfer function.
"""
@staticmethod
def transfer(**kwargs) -> np.array:
"""
Hyperbolic tangent transfer function.
Parameters
----------
x : numpy.array
the results of the FCM update function.
Return
-------
y : numpy.array,
domain R,
range [-1,1].
"""
x = kwargs['x']
return np.tanh(x)Classes
class Bivalent-
Bivalent transfer method
Expand source code
class Bivalent(Transfer): """ Bivalent transfer method """ @staticmethod def transfer(**kwargs) -> np.array: """ Bivalent transfer function. Parameters ---------- x : numpy.array, the results of the FCM update function. Return ------- y : numpy.array, domain R, range [0;1]. """ x = kwargs['x'] res = np.array([1 if i > 0 else 0 for i in x]) return resAncestors
- Transfer
- abc.ABC
Static methods
def transfer(**kwargs) ‑>-
Bivalent transfer function.
Parameters
x:numpy.array,- the results of the FCM update function.
Return
y : numpy.array, domain R, range [0;1].
Expand source code
@staticmethod def transfer(**kwargs) -> np.array: """ Bivalent transfer function. Parameters ---------- x : numpy.array, the results of the FCM update function. Return ------- y : numpy.array, domain R, range [0;1]. """ x = kwargs['x'] res = np.array([1 if i > 0 else 0 for i in x]) return res
class HyperbolicTangent-
Hyperbolic tangent transfer function.
Expand source code
class HyperbolicTangent(Transfer): """ Hyperbolic tangent transfer function. """ @staticmethod def transfer(**kwargs) -> np.array: """ Hyperbolic tangent transfer function. Parameters ---------- x : numpy.array the results of the FCM update function. Return ------- y : numpy.array, domain R, range [-1,1]. """ x = kwargs['x'] return np.tanh(x)Ancestors
- Transfer
- abc.ABC
Static methods
def transfer(**kwargs) ‑>-
Hyperbolic tangent transfer function.
Parameters
x:numpy.array- the results of the FCM update function.
Return
y : numpy.array, domain R, range [-1,1].
Expand source code
@staticmethod def transfer(**kwargs) -> np.array: """ Hyperbolic tangent transfer function. Parameters ---------- x : numpy.array the results of the FCM update function. Return ------- y : numpy.array, domain R, range [-1,1]. """ x = kwargs['x'] return np.tanh(x)
class Sigmoid-
Sigmoid transfer method
Expand source code
class Sigmoid(Transfer): """ Sigmoid transfer method """ @staticmethod def transfer(**kwargs) -> np.array: """ Sigmoid transfer function. Parameters ---------- x : numpy.array, the results of the FCM update function. l : int/float A parameter that determines the steepness of the sigmoid function at values around 0. Return ------- y : numpy.array, domain R, range [0,1]. """ x = kwargs['x'] l = kwargs['params']['l'] e = np.exp(1) res = 1/(1+(e**(-l*x))) return resAncestors
- Transfer
- abc.ABC
Static methods
def transfer(**kwargs) ‑>-
Sigmoid transfer function.
Parameters
x:numpy.array,- the results of the FCM update function.
l:int/float- A parameter that determines the steepness of the sigmoid function at values around 0.
Return
y : numpy.array, domain R, range [0,1].
Expand source code
@staticmethod def transfer(**kwargs) -> np.array: """ Sigmoid transfer function. Parameters ---------- x : numpy.array, the results of the FCM update function. l : int/float A parameter that determines the steepness of the sigmoid function at values around 0. Return ------- y : numpy.array, domain R, range [0,1]. """ x = kwargs['x'] l = kwargs['params']['l'] e = np.exp(1) res = 1/(1+(e**(-l*x))) return res
class Transfer-
Class of FCM transfer methods.
Expand source code
class Transfer(ABC): """ Class of FCM transfer methods. """ @abstractmethod def transfer() -> np.array: raise NotImplementedError('Transfer method is not defined!')Ancestors
- abc.ABC
Subclasses
Methods
def transfer() ‑>-
Expand source code
@abstractmethod def transfer() -> np.array: raise NotImplementedError('Transfer method is not defined!')
class Trivalent-
Trivalent transfer function.
Expand source code
class Trivalent(Transfer): """ Trivalent transfer function. """ @staticmethod def transfer(**kwargs) -> np.array: """ Trivalent transfer function. Parameters ---------- x : numpy.array, the results of the FCM update function. Return ---------- y : numpy.array, domain R, range [-1,0,1]. """ x = kwargs['x'] res = np.array([1 if i > 0 else -1 if i < 0 else 0 for i in x]) return resAncestors
- Transfer
- abc.ABC
Static methods
def transfer(**kwargs) ‑>-
Trivalent transfer function.
Parameters
x:numpy.array,- the results of the FCM update function.
Return
y : numpy.array, domain R, range [-1,0,1].
Expand source code
@staticmethod def transfer(**kwargs) -> np.array: """ Trivalent transfer function. Parameters ---------- x : numpy.array, the results of the FCM update function. Return ---------- y : numpy.array, domain R, range [-1,0,1]. """ x = kwargs['x'] res = np.array([1 if i > 0 else -1 if i < 0 else 0 for i in x]) return res