Skip to content

coordinate

Represents a coordinate in an N-dimensional space.

Attributes:

Name Type Description
coords tuple[int, ...]

The tuple representing the coordinate in N-dimensional space.

Methods:

Name Description
__add__

Adds another coordinate to this one.
__sub__

Subtracts another coordinate from this one.
__repr__

Returns a string representation of the coordinate.
__eq__

Checks equality of two coordinates.
__lt__

Compares if this coordinate is less than another.
__le__

Compares if this coordinate is less than or equal to another.
__gt__

Compares if this coordinate is greater than another.
__ge__

Compares if this coordinate is greater than or equal to another.
__hash__

Returns the hash of the coordinate.
dimension

Returns the dimension of the coordinate.
distance_to

Calculates the distance to another coordinate using a specified kernel.
Source code in tinybig/koala/geometry/coordinate.py 
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
class coordinate:
    """
        Represents a coordinate in an N-dimensional space.

        Attributes
        ----------
        coords : tuple[int, ...]
            The tuple representing the coordinate in N-dimensional space.

        Methods
        -------
        __add__(other)
            Adds another coordinate to this one.
        __sub__(other)
            Subtracts another coordinate from this one.
        __repr__()
            Returns a string representation of the coordinate.
        __eq__(other)
            Checks equality of two coordinates.
        __lt__(other)
            Compares if this coordinate is less than another.
        __le__(other)
            Compares if this coordinate is less than or equal to another.
        __gt__(other)
            Compares if this coordinate is greater than another.
        __ge__(other)
            Compares if this coordinate is greater than or equal to another.
        __hash__()
            Returns the hash of the coordinate.
        dimension()
            Returns the dimension of the coordinate.
        distance_to(other, kernel_name='euclidean_distance')
            Calculates the distance to another coordinate using a specified kernel.
    """
    def __init__(self, coords: tuple[int, ...], *args, **kwargs):
        """
            Initializes a generic N-dimensional coordinate object.

            This class serves as a base for representing a point in an N-dimensional
            space, defined by a tuple of integer coordinates.

            Parameters
            ----------
            coords : tuple[int, ...]
                A tuple representing the N-dimensional coordinates of the point.
            *args, **kwargs
                Additional arguments for future extensibility.

            Attributes
            ----------
            coords : tuple[int, ...]
                Stores the coordinates of the point in N-dimensional space.

        """
        self.coords = coords

    def __add__(self, other):
        """
            Adds another coordinate to this one.

            Parameters
            ----------
            other : coordinate
                The coordinate to add.

            Returns
            -------
            coordinate
                The resulting coordinate after addition.

            Raises
            ------
            TypeError
                If the operands are not of the same type or dimensions.
        """
        if isinstance(other, self.__class__) and len(self.coords) == len(other.coords):
            return self.__class__(tuple(a + b for a, b in zip(self.coords, other.coords)))
        raise TypeError("Operands must be of type Coordinate and have the same dimensions")

    # Redefine the - operator
    def __sub__(self, other):
        """
            Subtracts another coordinate from this one.

            Parameters
            ----------
            other : coordinate
                The coordinate to subtract.

            Returns
            -------
            coordinate
                The resulting coordinate after subtraction.

            Raises
            ------
            TypeError
                If the operands are not of the same type or dimensions.
        """
        if isinstance(other, self.__class__) and len(self.coords) == len(other.coords):
            return self.__class__(tuple(a - b for a, b in zip(self.coords, other.coords)))
        raise TypeError("Operands must be of type Coordinate and have the same dimensions")

    def __repr__(self):
        """
            Returns a string representation of the coordinate.

            Returns
            -------
            str
                The string representation of the coordinate.
        """
        return f"{self.__class__.__name__}{self.coords}"

    # Optionally, add equality checking
    def __eq__(self, other):
        """
            Checks equality of two coordinates.

            Parameters
            ----------
            other : coordinate
                The coordinate to compare.

            Returns
            -------
            bool
                True if coordinates are equal, False otherwise.
        """
        return isinstance(other, self.__class__) and self.dimension() == other.dimension() and self.coords == other.coords

    def __lt__(self, other):
        """
            Checks if this coordinate is less than another coordinate.

            Parameters
            ----------
            other : coordinate
                The coordinate to compare.

            Returns
            -------
            bool
                True if this coordinate is less than or equal to the other coordinate, False otherwise.

            Raises
            ------
            TypeError
                If the coordinates are not of the same type or dimension.
        """
        return isinstance(other, self.__class__) and self.dimension() == other.dimension() and self.coords < other.coords

    def __le__(self, other):
        """
            Checks if this coordinate is less than or equal to another coordinate.

            Parameters
            ----------
            other : coordinate
                The coordinate to compare.

            Returns
            -------
            bool
                True if this coordinate is less than or equal to the other coordinate, False otherwise.

            Raises
            ------
            TypeError
                If the coordinates are not of the same type or dimension.
        """
        return isinstance(other, self.__class__) and self.dimension() == other.dimension() and self.coords <= other.coords

    def __gt__(self, other):
        """
            Checks if this coordinate is greater than another coordinate.

            Parameters
            ----------
            other : coordinate
                The coordinate to compare.

            Returns
            -------
            bool
                True if this coordinate is greater than the other coordinate, False otherwise.

            Raises
            ------
            TypeError
                If the coordinates are not of the same type or dimension.
        """
        return isinstance(other, self.__class__) and self.dimension() == other.dimension() and self.coords > other.coords

    def __ge__(self, other):
        """
            Checks if this coordinate is greater than or equal to another coordinate.

            Parameters
            ----------
            other : coordinate
                The coordinate to compare.

            Returns
            -------
            bool
                True if this coordinate is greater than or equal to the other coordinate, False otherwise.

            Raises
            ------
            TypeError
                If the coordinates are not of the same type or dimension.
        """
        return isinstance(other, self.__class__) and self.dimension() == other.dimension() and self.coords >= other.coords

    def __hash__(self):
        """
            Returns the hash value of the coordinate.

            Returns
            -------
            int
                The hash value based on the coordinate's tuple representation.
        """
        return hash(self.coords)

    def dimension(self):
        """
            Returns the dimension of the coordinate.

            Returns
            -------
            int
                The dimension of the coordinate.
        """
        return len(self.coords)

    def distance_to(self, other, kernel_name: str = 'euclidean_distance'):
        """
            Calculates the distance to another coordinate using a specified kernel.

            Parameters
            ----------
            other : coordinate
                The coordinate to calculate the distance to.
            kernel_name : str, optional
                The name of the kernel to use for distance calculation (default is 'euclidean_distance').

            Returns
            -------
            float
                The distance to the other coordinate.

            Raises
            ------
            TypeError
                If the operands are not of the same type or dimensions.
        """
        if isinstance(other, self.__class__) and len(self.coords) == len(other.coords):
            return kernel(kernel_name=kernel_name, x=torch.tensor(self.coords, dtype=torch.float), x2=torch.tensor(other.coords, dtype=torch.float)).item()
        raise TypeError("Operands must be of type Coordinate and have the same dimensions")

__add__(other)

Adds another coordinate to this one.

Parameters:

Name Type Description Default
other coordinate

The coordinate to add.

 required

Returns:

Type Description
coordinate

The resulting coordinate after addition.

Raises:

Type Description
TypeError

If the operands are not of the same type or dimensions.
Source code in tinybig/koala/geometry/coordinate.py 
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
def __add__(self, other):
    """
        Adds another coordinate to this one.

        Parameters
        ----------
        other : coordinate
            The coordinate to add.

        Returns
        -------
        coordinate
            The resulting coordinate after addition.

        Raises
        ------
        TypeError
            If the operands are not of the same type or dimensions.
    """
    if isinstance(other, self.__class__) and len(self.coords) == len(other.coords):
        return self.__class__(tuple(a + b for a, b in zip(self.coords, other.coords)))
    raise TypeError("Operands must be of type Coordinate and have the same dimensions")

__eq__(other)

Checks equality of two coordinates.

Parameters:

Name Type Description Default
other coordinate

The coordinate to compare.

 required

Returns:

Type Description
bool

True if coordinates are equal, False otherwise.
Source code in tinybig/koala/geometry/coordinate.py 
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
def __eq__(self, other):
    """
        Checks equality of two coordinates.

        Parameters
        ----------
        other : coordinate
            The coordinate to compare.

        Returns
        -------
        bool
            True if coordinates are equal, False otherwise.
    """
    return isinstance(other, self.__class__) and self.dimension() == other.dimension() and self.coords == other.coords

__ge__(other)

Checks if this coordinate is greater than or equal to another coordinate.

Parameters:

Name Type Description Default
other coordinate

The coordinate to compare.

 required

Returns:

Type Description
bool

True if this coordinate is greater than or equal to the other coordinate, False otherwise.

Raises:

Type Description
TypeError

If the coordinates are not of the same type or dimension.
Source code in tinybig/koala/geometry/coordinate.py 
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
def __ge__(self, other):
    """
        Checks if this coordinate is greater than or equal to another coordinate.

        Parameters
        ----------
        other : coordinate
            The coordinate to compare.

        Returns
        -------
        bool
            True if this coordinate is greater than or equal to the other coordinate, False otherwise.

        Raises
        ------
        TypeError
            If the coordinates are not of the same type or dimension.
    """
    return isinstance(other, self.__class__) and self.dimension() == other.dimension() and self.coords >= other.coords

__gt__(other)

Checks if this coordinate is greater than another coordinate.

Parameters:

Name Type Description Default
other coordinate

The coordinate to compare.

 required

Returns:

Type Description
bool

True if this coordinate is greater than the other coordinate, False otherwise.

Raises:

Type Description
TypeError

If the coordinates are not of the same type or dimension.
Source code in tinybig/koala/geometry/coordinate.py 
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
def __gt__(self, other):
    """
        Checks if this coordinate is greater than another coordinate.

        Parameters
        ----------
        other : coordinate
            The coordinate to compare.

        Returns
        -------
        bool
            True if this coordinate is greater than the other coordinate, False otherwise.

        Raises
        ------
        TypeError
            If the coordinates are not of the same type or dimension.
    """
    return isinstance(other, self.__class__) and self.dimension() == other.dimension() and self.coords > other.coords

__hash__()

Returns the hash value of the coordinate.

Returns:

Type Description
int

The hash value based on the coordinate's tuple representation.
Source code in tinybig/koala/geometry/coordinate.py 
230
231
232
233
234
235
236
237
238
239
def __hash__(self):
    """
        Returns the hash value of the coordinate.

        Returns
        -------
        int
            The hash value based on the coordinate's tuple representation.
    """
    return hash(self.coords)

__init__(coords, *args, **kwargs)

Initializes a generic N-dimensional coordinate object.

This class serves as a base for representing a point in an N-dimensional space, defined by a tuple of integer coordinates.

Parameters:

Name Type Description Default
coords tuple[int, ...]

A tuple representing the N-dimensional coordinates of the point.

 required
*args

Additional arguments for future extensibility.

 ()
**kwargs

Additional arguments for future extensibility.

 ()

Attributes:

Name Type Description
coords tuple[int, ...]

Stores the coordinates of the point in N-dimensional space.
Source code in tinybig/koala/geometry/coordinate.py 
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
def __init__(self, coords: tuple[int, ...], *args, **kwargs):
    """
        Initializes a generic N-dimensional coordinate object.

        This class serves as a base for representing a point in an N-dimensional
        space, defined by a tuple of integer coordinates.

        Parameters
        ----------
        coords : tuple[int, ...]
            A tuple representing the N-dimensional coordinates of the point.
        *args, **kwargs
            Additional arguments for future extensibility.

        Attributes
        ----------
        coords : tuple[int, ...]
            Stores the coordinates of the point in N-dimensional space.

    """
    self.coords = coords

__le__(other)

Checks if this coordinate is less than or equal to another coordinate.

Parameters:

Name Type Description Default
other coordinate

The coordinate to compare.

 required

Returns:

Type Description
bool

True if this coordinate is less than or equal to the other coordinate, False otherwise.

Raises:

Type Description
TypeError

If the coordinates are not of the same type or dimension.
Source code in tinybig/koala/geometry/coordinate.py 
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
def __le__(self, other):
    """
        Checks if this coordinate is less than or equal to another coordinate.

        Parameters
        ----------
        other : coordinate
            The coordinate to compare.

        Returns
        -------
        bool
            True if this coordinate is less than or equal to the other coordinate, False otherwise.

        Raises
        ------
        TypeError
            If the coordinates are not of the same type or dimension.
    """
    return isinstance(other, self.__class__) and self.dimension() == other.dimension() and self.coords <= other.coords

__lt__(other)

Checks if this coordinate is less than another coordinate.

Parameters:

Name Type Description Default
other coordinate

The coordinate to compare.

 required

Returns:

Type Description
bool

True if this coordinate is less than or equal to the other coordinate, False otherwise.

Raises:

Type Description
TypeError

If the coordinates are not of the same type or dimension.
Source code in tinybig/koala/geometry/coordinate.py 
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
def __lt__(self, other):
    """
        Checks if this coordinate is less than another coordinate.

        Parameters
        ----------
        other : coordinate
            The coordinate to compare.

        Returns
        -------
        bool
            True if this coordinate is less than or equal to the other coordinate, False otherwise.

        Raises
        ------
        TypeError
            If the coordinates are not of the same type or dimension.
    """
    return isinstance(other, self.__class__) and self.dimension() == other.dimension() and self.coords < other.coords

__repr__()

Returns a string representation of the coordinate.

Returns:

Type Description
str

The string representation of the coordinate.
Source code in tinybig/koala/geometry/coordinate.py 
118
119
120
121
122
123
124
125
126
127
def __repr__(self):
    """
        Returns a string representation of the coordinate.

        Returns
        -------
        str
            The string representation of the coordinate.
    """
    return f"{self.__class__.__name__}{self.coords}"

__sub__(other)

Subtracts another coordinate from this one.

Parameters:

Name Type Description Default
other coordinate

The coordinate to subtract.

 required

Returns:

Type Description
coordinate

The resulting coordinate after subtraction.

Raises:

Type Description
TypeError

If the operands are not of the same type or dimensions.
Source code in tinybig/koala/geometry/coordinate.py 
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
def __sub__(self, other):
    """
        Subtracts another coordinate from this one.

        Parameters
        ----------
        other : coordinate
            The coordinate to subtract.

        Returns
        -------
        coordinate
            The resulting coordinate after subtraction.

        Raises
        ------
        TypeError
            If the operands are not of the same type or dimensions.
    """
    if isinstance(other, self.__class__) and len(self.coords) == len(other.coords):
        return self.__class__(tuple(a - b for a, b in zip(self.coords, other.coords)))
    raise TypeError("Operands must be of type Coordinate and have the same dimensions")

dimension()

Returns the dimension of the coordinate.

Returns:

Type Description
int

The dimension of the coordinate.
Source code in tinybig/koala/geometry/coordinate.py 
241
242
243
244
245
246
247
248
249
250
def dimension(self):
    """
        Returns the dimension of the coordinate.

        Returns
        -------
        int
            The dimension of the coordinate.
    """
    return len(self.coords)

distance_to(other, kernel_name='euclidean_distance')

Calculates the distance to another coordinate using a specified kernel.

Parameters:

Name Type Description Default
other coordinate

The coordinate to calculate the distance to.

 required
kernel_name str

The name of the kernel to use for distance calculation (default is 'euclidean_distance').

 'euclidean_distance'

Returns:

Type Description
float

The distance to the other coordinate.

Raises:

Type Description
TypeError

If the operands are not of the same type or dimensions.
Source code in tinybig/koala/geometry/coordinate.py 
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
def distance_to(self, other, kernel_name: str = 'euclidean_distance'):
    """
        Calculates the distance to another coordinate using a specified kernel.

        Parameters
        ----------
        other : coordinate
            The coordinate to calculate the distance to.
        kernel_name : str, optional
            The name of the kernel to use for distance calculation (default is 'euclidean_distance').

        Returns
        -------
        float
            The distance to the other coordinate.

        Raises
        ------
        TypeError
            If the operands are not of the same type or dimensions.
    """
    if isinstance(other, self.__class__) and len(self.coords) == len(other.coords):
        return kernel(kernel_name=kernel_name, x=torch.tensor(self.coords, dtype=torch.float), x2=torch.tensor(other.coords, dtype=torch.float)).item()
    raise TypeError("Operands must be of type Coordinate and have the same dimensions")