@@ -165,6 +165,8 @@ def set_column(self, label: str, value: Column) -> DataFrame:
165
165
166
166
def __eq__ (self , other : DataFrame | "Scalar" ) -> DataFrame :
167
167
"""
168
+ Compare for equality.
169
+
168
170
Parameters
169
171
----------
170
172
other : DataFrame or Scalar
@@ -180,6 +182,8 @@ def __eq__(self, other: DataFrame | "Scalar") -> DataFrame:
180
182
181
183
def __ne__ (self , other : DataFrame | "Scalar" ) -> DataFrame :
182
184
"""
185
+ Compare for non-equality.
186
+
183
187
Parameters
184
188
----------
185
189
other : DataFrame or Scalar
@@ -195,6 +199,8 @@ def __ne__(self, other: DataFrame | "Scalar") -> DataFrame:
195
199
196
200
def __ge__ (self , other : DataFrame | "Scalar" ) -> DataFrame :
197
201
"""
202
+ Compare for "greater than or equal to" `other`.
203
+
198
204
Parameters
199
205
----------
200
206
other : DataFrame or Scalar
@@ -210,6 +216,8 @@ def __ge__(self, other: DataFrame | "Scalar") -> DataFrame:
210
216
211
217
def __gt__ (self , other : DataFrame | "Scalar" ) -> DataFrame :
212
218
"""
219
+ Compare for "greater than" `other`.
220
+
213
221
Parameters
214
222
----------
215
223
other : DataFrame or Scalar
@@ -225,6 +233,8 @@ def __gt__(self, other: DataFrame | "Scalar") -> DataFrame:
225
233
226
234
def __le__ (self , other : DataFrame | "Scalar" ) -> DataFrame :
227
235
"""
236
+ Compare for "less than or equal to" `other`.
237
+
228
238
Parameters
229
239
----------
230
240
other : DataFrame or Scalar
@@ -240,6 +250,8 @@ def __le__(self, other: DataFrame | "Scalar") -> DataFrame:
240
250
241
251
def __lt__ (self , other : DataFrame | "Scalar" ) -> DataFrame :
242
252
"""
253
+ Compare for "less than" `other`.
254
+
243
255
Parameters
244
256
----------
245
257
other : DataFrame or Scalar
@@ -255,6 +267,8 @@ def __lt__(self, other: DataFrame | "Scalar") -> DataFrame:
255
267
256
268
def __add__ (self , other : DataFrame | "Scalar" ) -> DataFrame :
257
269
"""
270
+ Add `other` dataframe or scalar to this dataframe.
271
+
258
272
Parameters
259
273
----------
260
274
other : DataFrame or Scalar
@@ -270,6 +284,8 @@ def __add__(self, other: DataFrame | "Scalar") -> DataFrame:
270
284
271
285
def __sub__ (self , other : DataFrame | "Scalar" ) -> DataFrame :
272
286
"""
287
+ Subtract `other` dataframe or scalar from this dataframe.
288
+
273
289
Parameters
274
290
----------
275
291
other : DataFrame or Scalar
@@ -285,6 +301,8 @@ def __sub__(self, other: DataFrame | "Scalar") -> DataFrame:
285
301
286
302
def __mul__ (self , other : DataFrame | "Scalar" ) -> DataFrame :
287
303
"""
304
+ Multiply `other` dataframe or scalar with this dataframe.
305
+
288
306
Parameters
289
307
----------
290
308
other : DataFrame or Scalar
@@ -300,6 +318,8 @@ def __mul__(self, other: DataFrame | "Scalar") -> DataFrame:
300
318
301
319
def __truediv__ (self , other : DataFrame | "Scalar" ) -> DataFrame :
302
320
"""
321
+ Divide this dataframe by `other` dataframe or scalar. True division, returns floats.
322
+
303
323
Parameters
304
324
----------
305
325
other : DataFrame or Scalar
@@ -315,6 +335,8 @@ def __truediv__(self, other: DataFrame | "Scalar") -> DataFrame:
315
335
316
336
def __floordiv__ (self , other : DataFrame | "Scalar" ) -> DataFrame :
317
337
"""
338
+ Floor-divide (returns integers) this dataframe by `other` dataframe or scalar.
339
+
318
340
Parameters
319
341
----------
320
342
other : DataFrame or Scalar
@@ -330,6 +352,8 @@ def __floordiv__(self, other: DataFrame | "Scalar") -> DataFrame:
330
352
331
353
def __pow__ (self , other : DataFrame | "Scalar" ) -> DataFrame :
332
354
"""
355
+ Raise this dataframe to the power of `other`.
356
+
333
357
Parameters
334
358
----------
335
359
other : DataFrame or Scalar
@@ -345,6 +369,8 @@ def __pow__(self, other: DataFrame | "Scalar") -> DataFrame:
345
369
346
370
def __mod__ (self , other : DataFrame | "Scalar" ) -> DataFrame :
347
371
"""
372
+ Return modulus of this dataframe by `other` (`%` operator).
373
+
348
374
Parameters
349
375
----------
350
376
other : DataFrame or Scalar
@@ -360,6 +386,8 @@ def __mod__(self, other: DataFrame | "Scalar") -> DataFrame:
360
386
361
387
def __divmod__ (self , other : DataFrame | "Scalar" ) -> tuple [DataFrame , DataFrame ]:
362
388
"""
389
+ Return quotient and remainder of integer division. See `divmod` builtin function.
390
+
363
391
Parameters
364
392
----------
365
393
other : DataFrame or Scalar
@@ -369,8 +397,7 @@ def __divmod__(self, other: DataFrame | "Scalar") -> tuple[DataFrame, DataFrame]
369
397
370
398
Returns
371
399
-------
372
- DataFrame
373
- DataFrame
400
+ A tuple of two DataFrame's
374
401
"""
375
402
...
376
403
0 commit comments