cylinder_patch_based_geometric_interdependence

Bases: geometric_interdependence

A geometric interdependence class using cylindrical patches.

This class applies geometric interdependence based on cylinder-shaped patches within a grid structure.

Attributes:

Name	Type	Description
patch	cylinder	The cylinder patch structure used for interdependence.

Methods:

Name	Description
__init__	Initializes the cylindrical patch-based geometric interdependence function.

Source code in tinybig/interdependence/geometric_interdependence.py

class cylinder_patch_based_geometric_interdependence(geometric_interdependence):
    """
        A geometric interdependence class using cylindrical patches.

        This class applies geometric interdependence based on cylinder-shaped patches within a grid structure.

        Attributes
        ----------
        patch : cylinder
            The cylinder patch structure used for interdependence.

        Methods
        -------
        __init__(r, p_d, p_d_prime=None, ...)
            Initializes the cylindrical patch-based geometric interdependence function.
    """

    def __init__(
        self,
        r: int, p_d: int, p_d_prime: int = None,
        name: str = 'cylinder_patch_based_geometric_interdependence',
        *args, **kwargs
    ):
        """
            Initializes the cylindrical patch-based geometric interdependence function.

            Parameters
            ----------
            r : int
                Radius of the cylinder patch.
            p_d : int
                Depth of the cylinder patch.
            p_d_prime : int, optional
                Output depth of the cylinder patch. Defaults to None.
            name : str, optional
                Name of the interdependence function. Defaults to 'cylinder_patch_based_geometric_interdependence'.
            *args : tuple
                Additional positional arguments for the parent class.
            **kwargs : dict
                Additional keyword arguments for the parent class.
        """
        patch = cylinder(r=r, p_d=p_d, p_d_prime=p_d_prime)
        super().__init__(name=name, patch=patch, *args, **kwargs)

__init__(r, p_d, p_d_prime=None, name='cylinder_patch_based_geometric_interdependence', *args, **kwargs)

Initializes the cylindrical patch-based geometric interdependence function.

Parameters:

Name	Type	Description	Default
r	int	Radius of the cylinder patch.	required
p_d	int	Depth of the cylinder patch.	required
p_d_prime	int	Output depth of the cylinder patch. Defaults to None.	None
name	str	Name of the interdependence function. Defaults to 'cylinder_patch_based_geometric_interdependence'.	'cylinder_patch_based_geometric_interdependence'
*args	tuple	Additional positional arguments for the parent class.	()
**kwargs	dict	Additional keyword arguments for the parent class.	{}

Source code in tinybig/interdependence/geometric_interdependence.py

def __init__(
    self,
    r: int, p_d: int, p_d_prime: int = None,
    name: str = 'cylinder_patch_based_geometric_interdependence',
    *args, **kwargs
):
    """
        Initializes the cylindrical patch-based geometric interdependence function.

        Parameters
        ----------
        r : int
            Radius of the cylinder patch.
        p_d : int
            Depth of the cylinder patch.
        p_d_prime : int, optional
            Output depth of the cylinder patch. Defaults to None.
        name : str, optional
            Name of the interdependence function. Defaults to 'cylinder_patch_based_geometric_interdependence'.
        *args : tuple
            Additional positional arguments for the parent class.
        **kwargs : dict
            Additional keyword arguments for the parent class.
    """
    patch = cylinder(r=r, p_d=p_d, p_d_prime=p_d_prime)
    super().__init__(name=name, patch=patch, *args, **kwargs)