Skip to content

Cell

Bases: ABC, Generic[T_co]

A single value in a table.

This class cannot be instantiated directly. It is only used for arguments of callbacks.

Source code in src/safeds/data/tabular/containers/_cell.py
 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
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
class Cell(ABC, Generic[T_co]):
    """
    A single value in a table.

    This class cannot be instantiated directly. It is only used for arguments of callbacks.
    """

    # ------------------------------------------------------------------------------------------------------------------
    # Static methods
    # ------------------------------------------------------------------------------------------------------------------

    @staticmethod
    def first_not_none(cells: list[Cell]) -> Cell:
        """
        Return the first cell from the given list that is not None.

        Parameters
        ----------
        cells:
            The list of cells to be searched.

        Returns
        -------
        cell:
            Returns the contents of the first cell that is not None.
            If all cells in the list are None or the list is empty returns None.
        """
        import polars as pl

        from ._lazy_cell import _LazyCell  # circular import

        return _LazyCell(pl.coalesce([cell._polars_expression for cell in cells]))

    # ------------------------------------------------------------------------------------------------------------------
    # Dunder methods
    # ------------------------------------------------------------------------------------------------------------------

    # "Boolean" operators (actually bitwise) -----------------------------------

    @abstractmethod
    def __invert__(self) -> Cell[bool]: ...

    @abstractmethod
    def __and__(self, other: bool | Cell[bool]) -> Cell[bool]: ...

    @abstractmethod
    def __rand__(self, other: bool | Cell[bool]) -> Cell[bool]: ...

    @abstractmethod
    def __or__(self, other: bool | Cell[bool]) -> Cell[bool]: ...

    @abstractmethod
    def __ror__(self, other: bool | Cell[bool]) -> Cell[bool]: ...

    @abstractmethod
    def __xor__(self, other: bool | Cell[bool]) -> Cell[bool]: ...

    @abstractmethod
    def __rxor__(self, other: bool | Cell[bool]) -> Cell[bool]: ...

    # Comparison ---------------------------------------------------------------

    @abstractmethod
    def __eq__(self, other: object) -> Cell[bool]:  # type: ignore[override]
        ...

    @abstractmethod
    def __ge__(self, other: Any) -> Cell[bool]: ...

    @abstractmethod
    def __gt__(self, other: Any) -> Cell[bool]: ...

    @abstractmethod
    def __le__(self, other: Any) -> Cell[bool]: ...

    @abstractmethod
    def __lt__(self, other: Any) -> Cell[bool]: ...

    @abstractmethod
    def __ne__(self, other: object) -> Cell[bool]:  # type: ignore[override]
        ...

    # Numeric operators --------------------------------------------------------

    @abstractmethod
    def __abs__(self) -> Cell[R_co]: ...

    @abstractmethod
    def __ceil__(self) -> Cell[R_co]: ...

    @abstractmethod
    def __floor__(self) -> Cell[R_co]: ...

    @abstractmethod
    def __neg__(self) -> Cell[R_co]: ...

    @abstractmethod
    def __pos__(self) -> Cell[R_co]: ...

    @abstractmethod
    def __add__(self, other: Any) -> Cell[R_co]: ...

    @abstractmethod
    def __radd__(self, other: Any) -> Cell[R_co]: ...

    @abstractmethod
    def __floordiv__(self, other: Any) -> Cell[R_co]: ...

    @abstractmethod
    def __rfloordiv__(self, other: Any) -> Cell[R_co]: ...

    @abstractmethod
    def __mod__(self, other: Any) -> Cell[R_co]: ...

    @abstractmethod
    def __rmod__(self, other: Any) -> Cell[R_co]: ...

    @abstractmethod
    def __mul__(self, other: Any) -> Cell[R_co]: ...

    @abstractmethod
    def __rmul__(self, other: Any) -> Cell[R_co]: ...

    @abstractmethod
    def __pow__(self, other: float | Cell[P_contra]) -> Cell[R_co]: ...

    @abstractmethod
    def __rpow__(self, other: float | Cell[P_contra]) -> Cell[R_co]: ...

    @abstractmethod
    def __sub__(self, other: Any) -> Cell[R_co]: ...

    @abstractmethod
    def __rsub__(self, other: Any) -> Cell[R_co]: ...

    @abstractmethod
    def __truediv__(self, other: Any) -> Cell[R_co]: ...

    @abstractmethod
    def __rtruediv__(self, other: Any) -> Cell[R_co]: ...

    # Other --------------------------------------------------------------------

    @abstractmethod
    def __hash__(self) -> int: ...

    @abstractmethod
    def __sizeof__(self) -> int: ...

    # ------------------------------------------------------------------------------------------------------------------
    # Properties
    # ------------------------------------------------------------------------------------------------------------------

    @property
    @abstractmethod
    def str(self) -> StringCell:
        """Namespace for operations on strings."""

    @property
    @abstractmethod
    def dt(self) -> TemporalCell:
        """Namespace for operations on date time values."""

    # ------------------------------------------------------------------------------------------------------------------
    # Boolean operations
    # ------------------------------------------------------------------------------------------------------------------

    def not_(self) -> Cell[bool]:
        """
        Negate a boolean. This is equivalent to the `~` operator.

        Examples
        --------
        >>> from safeds.data.tabular.containers import Column
        >>> column = Column("example", [True, False])
        >>> column.transform(lambda cell: cell.not_())
        +---------+
        | example |
        | ---     |
        | bool    |
        +=========+
        | false   |
        | true    |
        +---------+

        >>> column.transform(lambda cell: ~cell)
        +---------+
        | example |
        | ---     |
        | bool    |
        +=========+
        | false   |
        | true    |
        +---------+
        """
        return self.__invert__()

    def and_(self, other: bool | Cell[bool]) -> Cell[bool]:
        """
        Perform a boolean AND operation. This is equivalent to the `&` operator.

        Examples
        --------
        >>> from safeds.data.tabular.containers import Column
        >>> column = Column("example", [True, False])
        >>> column.transform(lambda cell: cell.and_(False))
        +---------+
        | example |
        | ---     |
        | bool    |
        +=========+
        | false   |
        | false   |
        +---------+

        >>> column.transform(lambda cell: cell & False)
        +---------+
        | example |
        | ---     |
        | bool    |
        +=========+
        | false   |
        | false   |
        +---------+
        """
        return self.__and__(other)

    def or_(self, other: bool | Cell[bool]) -> Cell[bool]:
        """
        Perform a boolean OR operation. This is equivalent to the `|` operator.

        Examples
        --------
        >>> from safeds.data.tabular.containers import Column
        >>> column = Column("example", [True, False])
        >>> column.transform(lambda cell: cell.or_(True))
        +---------+
        | example |
        | ---     |
        | bool    |
        +=========+
        | true    |
        | true    |
        +---------+

        >>> column.transform(lambda cell: cell | True)
        +---------+
        | example |
        | ---     |
        | bool    |
        +=========+
        | true    |
        | true    |
        +---------+
        """
        return self.__or__(other)

    def xor(self, other: bool | Cell[bool]) -> Cell[bool]:
        """
        Perform a boolean XOR operation. This is equivalent to the `^` operator.

        Examples
        --------
        >>> from safeds.data.tabular.containers import Column
        >>> column = Column("example", [True, False])
        >>> column.transform(lambda cell: cell.xor(True))
        +---------+
        | example |
        | ---     |
        | bool    |
        +=========+
        | false   |
        | true    |
        +---------+

        >>> column.transform(lambda cell: cell ^ True)
        +---------+
        | example |
        | ---     |
        | bool    |
        +=========+
        | false   |
        | true    |
        +---------+
        """
        return self.__xor__(other)

    # ------------------------------------------------------------------------------------------------------------------
    # Numeric operations
    # ------------------------------------------------------------------------------------------------------------------

    def abs(self) -> Cell[R_co]:
        """
        Get the absolute value.

        Examples
        --------
        >>> from safeds.data.tabular.containers import Column
        >>> column = Column("example", [1, -2])
        >>> column.transform(lambda cell: cell.abs())
        +---------+
        | example |
        |     --- |
        |     i64 |
        +=========+
        |       1 |
        |       2 |
        +---------+
        """
        return self.__abs__()

    def ceil(self) -> Cell[R_co]:
        """
        Round up to the nearest integer.

        Examples
        --------
        >>> from safeds.data.tabular.containers import Column
        >>> column = Column("example", [1.1, 2.9])
        >>> column.transform(lambda cell: cell.ceil())
        +---------+
        | example |
        |     --- |
        |     f64 |
        +=========+
        | 2.00000 |
        | 3.00000 |
        +---------+
        """
        return self.__ceil__()

    def floor(self) -> Cell[R_co]:
        """
        Round down to the nearest integer.

        Examples
        --------
        >>> from safeds.data.tabular.containers import Column
        >>> column = Column("example", [1.1, 2.9])
        >>> column.transform(lambda cell: cell.floor())
        +---------+
        | example |
        |     --- |
        |     f64 |
        +=========+
        | 1.00000 |
        | 2.00000 |
        +---------+
        """
        return self.__floor__()

    def neg(self) -> Cell[R_co]:
        """
        Negate the value.

        Examples
        --------
        >>> from safeds.data.tabular.containers import Column
        >>> column = Column("example", [1, -2])
        >>> column.transform(lambda cell: cell.neg())
        +---------+
        | example |
        |     --- |
        |     i64 |
        +=========+
        |      -1 |
        |       2 |
        +---------+
        """
        return self.__neg__()

    def add(self, other: Any) -> Cell[R_co]:
        """
        Add a value. This is equivalent to the `+` operator.

        Examples
        --------
        >>> from safeds.data.tabular.containers import Column
        >>> column = Column("example", [1, 2])
        >>> column.transform(lambda cell: cell.add(3))
        +---------+
        | example |
        |     --- |
        |     i64 |
        +=========+
        |       4 |
        |       5 |
        +---------+

        >>> column.transform(lambda cell: cell + 3)
        +---------+
        | example |
        |     --- |
        |     i64 |
        +=========+
        |       4 |
        |       5 |
        +---------+
        """
        return self.__add__(other)

    def div(self, other: Any) -> Cell[R_co]:
        """
        Divide by a value. This is equivalent to the `/` operator.

        Examples
        --------
        >>> from safeds.data.tabular.containers import Column
        >>> column = Column("example", [6, 8])
        >>> column.transform(lambda cell: cell.div(2))
        +---------+
        | example |
        |     --- |
        |     f64 |
        +=========+
        | 3.00000 |
        | 4.00000 |
        +---------+

        >>> column.transform(lambda cell: cell / 2)
        +---------+
        | example |
        |     --- |
        |     f64 |
        +=========+
        | 3.00000 |
        | 4.00000 |
        +---------+
        """
        return self.__truediv__(other)

    def mod(self, other: Any) -> Cell[R_co]:
        """
        Perform a modulo operation. This is equivalent to the `%` operator.

        Examples
        --------
        >>> from safeds.data.tabular.containers import Column
        >>> column = Column("example", [5, 6])
        >>> column.transform(lambda cell: cell.mod(3))
        +---------+
        | example |
        |     --- |
        |     i64 |
        +=========+
        |       2 |
        |       0 |
        +---------+

        >>> column.transform(lambda cell: cell % 3)
        +---------+
        | example |
        |     --- |
        |     i64 |
        +=========+
        |       2 |
        |       0 |
        +---------+
        """
        return self.__mod__(other)

    def mul(self, other: Any) -> Cell[R_co]:
        """
        Multiply by a value. This is equivalent to the `*` operator.

        Examples
        --------
        >>> from safeds.data.tabular.containers import Column
        >>> column = Column("example", [2, 3])
        >>> column.transform(lambda cell: cell.mul(4))
        +---------+
        | example |
        |     --- |
        |     i64 |
        +=========+
        |       8 |
        |      12 |
        +---------+

        >>> column.transform(lambda cell: cell * 4)
        +---------+
        | example |
        |     --- |
        |     i64 |
        +=========+
        |       8 |
        |      12 |
        +---------+
        """
        return self.__mul__(other)

    def pow(self, other: float | Cell[P_contra]) -> Cell[R_co]:
        """
        Raise to a power. This is equivalent to the `**` operator.

        Examples
        --------
        >>> from safeds.data.tabular.containers import Column
        >>> column = Column("example", [2, 3])
        >>> column.transform(lambda cell: cell.pow(3))
        +---------+
        | example |
        |     --- |
        |     i64 |
        +=========+
        |       8 |
        |      27 |
        +---------+

        >>> column.transform(lambda cell: cell ** 3)
        +---------+
        | example |
        |     --- |
        |     i64 |
        +=========+
        |       8 |
        |      27 |
        +---------+
        """
        return self.__pow__(other)

    def sub(self, other: Any) -> Cell[R_co]:
        """
        Subtract a value. This is equivalent to the `-` operator.

        Examples
        --------
        >>> from safeds.data.tabular.containers import Column
        >>> column = Column("example", [5, 6])
        >>> column.transform(lambda cell: cell.sub(3))
        +---------+
        | example |
        |     --- |
        |     i64 |
        +=========+
        |       2 |
        |       3 |
        +---------+

        >>> column.transform(lambda cell: cell - 3)
        +---------+
        | example |
        |     --- |
        |     i64 |
        +=========+
        |       2 |
        |       3 |
        +---------+
        """
        return self.__sub__(other)

    # ------------------------------------------------------------------------------------------------------------------
    # Comparison operations
    # ------------------------------------------------------------------------------------------------------------------

    def eq(self, other: Any) -> Cell[bool]:
        """
        Check if equal to a value. This is equivalent to the `==` operator.

        Examples
        --------
        >>> from safeds.data.tabular.containers import Column
        >>> column = Column("example", [1, 2])
        >>> column.transform(lambda cell: cell.eq(2))
        +---------+
        | example |
        | ---     |
        | bool    |
        +=========+
        | false   |
        | true    |
        +---------+

        >>> column.transform(lambda cell: cell == 2)
        +---------+
        | example |
        | ---     |
        | bool    |
        +=========+
        | false   |
        | true    |
        +---------+
        """
        return self.__eq__(other)

    def neq(self, other: Any) -> Cell[bool]:
        """
        Check if not equal to a value. This is equivalent to the `!=` operator.

        Examples
        --------
        >>> from safeds.data.tabular.containers import Column
        >>> column = Column("example", [1, 2])
        >>> column.transform(lambda cell: cell.neq(2))
        +---------+
        | example |
        | ---     |
        | bool    |
        +=========+
        | true    |
        | false   |
        +---------+

        >>> column.transform(lambda cell: cell != 2)
        +---------+
        | example |
        | ---     |
        | bool    |
        +=========+
        | true    |
        | false   |
        +---------+
        """
        return self.__ne__(other)

    def ge(self, other: Any) -> Cell[bool]:
        """
        Check if greater than or equal to a value. This is equivalent to the `>=` operator.

        Examples
        --------
        >>> from safeds.data.tabular.containers import Column
        >>> column = Column("example", [1, 2])
        >>> column.transform(lambda cell: cell.ge(2))
        +---------+
        | example |
        | ---     |
        | bool    |
        +=========+
        | false   |
        | true    |
        +---------+

        >>> column.transform(lambda cell: cell >= 2)
        +---------+
        | example |
        | ---     |
        | bool    |
        +=========+
        | false   |
        | true    |
        +---------+
        """
        return self.__ge__(other)

    def gt(self, other: Any) -> Cell[bool]:
        """
        Check if greater than a value. This is equivalent to the `>` operator.

        Examples
        --------
        >>> from safeds.data.tabular.containers import Column
        >>> column = Column("example", [1, 2])
        >>> column.transform(lambda cell: cell.gt(2))
        +---------+
        | example |
        | ---     |
        | bool    |
        +=========+
        | false   |
        | false   |
        +---------+

        >>> column.transform(lambda cell: cell > 2)
        +---------+
        | example |
        | ---     |
        | bool    |
        +=========+
        | false   |
        | false   |
        +---------+
        """
        return self.__gt__(other)

    def le(self, other: Any) -> Cell[bool]:
        """
        Check if less than or equal to a value. This is equivalent to the `<=` operator.

        Examples
        --------
        >>> from safeds.data.tabular.containers import Column
        >>> column = Column("example", [1, 2])
        >>> column.transform(lambda cell: cell.le(2))
        +---------+
        | example |
        | ---     |
        | bool    |
        +=========+
        | true    |
        | true    |
        +---------+

        >>> column.transform(lambda cell: cell <= 2)
        +---------+
        | example |
        | ---     |
        | bool    |
        +=========+
        | true    |
        | true    |
        +---------+
        """
        return self.__le__(other)

    def lt(self, other: Any) -> Cell[bool]:
        """
        Check if less than a value. This is equivalent to the `<` operator.

        Examples
        --------
        >>> from safeds.data.tabular.containers import Column
        >>> column = Column("example", [1, 2])
        >>> column.transform(lambda cell: cell.lt(2))
        +---------+
        | example |
        | ---     |
        | bool    |
        +=========+
        | true    |
        | false   |
        +---------+

        >>> column.transform(lambda cell: cell < 2)
        +---------+
        | example |
        | ---     |
        | bool    |
        +=========+
        | true    |
        | false   |
        +---------+
        """
        return self.__lt__(other)

    # ------------------------------------------------------------------------------------------------------------------
    # Internal
    # ------------------------------------------------------------------------------------------------------------------

    @property
    @abstractmethod
    def _polars_expression(self) -> pl.Expr:
        """The Polars expression that corresponds to this cell."""

    @abstractmethod
    def _equals(self, other: object) -> bool:
        """
        Check if this cell is equal to another object.

        This method is needed because the `__eq__` method is used for element-wise comparisons.
        """

dt: TemporalCell

Namespace for operations on date time values.

str: StringCell

Namespace for operations on strings.

abs

Get the absolute value.

Examples:

>>> from safeds.data.tabular.containers import Column
>>> column = Column("example", [1, -2])
>>> column.transform(lambda cell: cell.abs())
+---------+
| example |
|     --- |
|     i64 |
+=========+
|       1 |
|       2 |
+---------+
Source code in src/safeds/data/tabular/containers/_cell.py
def abs(self) -> Cell[R_co]:
    """
    Get the absolute value.

    Examples
    --------
    >>> from safeds.data.tabular.containers import Column
    >>> column = Column("example", [1, -2])
    >>> column.transform(lambda cell: cell.abs())
    +---------+
    | example |
    |     --- |
    |     i64 |
    +=========+
    |       1 |
    |       2 |
    +---------+
    """
    return self.__abs__()

add

Add a value. This is equivalent to the + operator.

Examples:

>>> from safeds.data.tabular.containers import Column
>>> column = Column("example", [1, 2])
>>> column.transform(lambda cell: cell.add(3))
+---------+
| example |
|     --- |
|     i64 |
+=========+
|       4 |
|       5 |
+---------+
>>> column.transform(lambda cell: cell + 3)
+---------+
| example |
|     --- |
|     i64 |
+=========+
|       4 |
|       5 |
+---------+
Source code in src/safeds/data/tabular/containers/_cell.py
def add(self, other: Any) -> Cell[R_co]:
    """
    Add a value. This is equivalent to the `+` operator.

    Examples
    --------
    >>> from safeds.data.tabular.containers import Column
    >>> column = Column("example", [1, 2])
    >>> column.transform(lambda cell: cell.add(3))
    +---------+
    | example |
    |     --- |
    |     i64 |
    +=========+
    |       4 |
    |       5 |
    +---------+

    >>> column.transform(lambda cell: cell + 3)
    +---------+
    | example |
    |     --- |
    |     i64 |
    +=========+
    |       4 |
    |       5 |
    +---------+
    """
    return self.__add__(other)

and_

Perform a boolean AND operation. This is equivalent to the & operator.

Examples:

>>> from safeds.data.tabular.containers import Column
>>> column = Column("example", [True, False])
>>> column.transform(lambda cell: cell.and_(False))
+---------+
| example |
| ---     |
| bool    |
+=========+
| false   |
| false   |
+---------+
>>> column.transform(lambda cell: cell & False)
+---------+
| example |
| ---     |
| bool    |
+=========+
| false   |
| false   |
+---------+
Source code in src/safeds/data/tabular/containers/_cell.py
def and_(self, other: bool | Cell[bool]) -> Cell[bool]:
    """
    Perform a boolean AND operation. This is equivalent to the `&` operator.

    Examples
    --------
    >>> from safeds.data.tabular.containers import Column
    >>> column = Column("example", [True, False])
    >>> column.transform(lambda cell: cell.and_(False))
    +---------+
    | example |
    | ---     |
    | bool    |
    +=========+
    | false   |
    | false   |
    +---------+

    >>> column.transform(lambda cell: cell & False)
    +---------+
    | example |
    | ---     |
    | bool    |
    +=========+
    | false   |
    | false   |
    +---------+
    """
    return self.__and__(other)

ceil

Round up to the nearest integer.

Examples:

>>> from safeds.data.tabular.containers import Column
>>> column = Column("example", [1.1, 2.9])
>>> column.transform(lambda cell: cell.ceil())
+---------+
| example |
|     --- |
|     f64 |
+=========+
| 2.00000 |
| 3.00000 |
+---------+
Source code in src/safeds/data/tabular/containers/_cell.py
def ceil(self) -> Cell[R_co]:
    """
    Round up to the nearest integer.

    Examples
    --------
    >>> from safeds.data.tabular.containers import Column
    >>> column = Column("example", [1.1, 2.9])
    >>> column.transform(lambda cell: cell.ceil())
    +---------+
    | example |
    |     --- |
    |     f64 |
    +=========+
    | 2.00000 |
    | 3.00000 |
    +---------+
    """
    return self.__ceil__()

div

Divide by a value. This is equivalent to the / operator.

Examples:

>>> from safeds.data.tabular.containers import Column
>>> column = Column("example", [6, 8])
>>> column.transform(lambda cell: cell.div(2))
+---------+
| example |
|     --- |
|     f64 |
+=========+
| 3.00000 |
| 4.00000 |
+---------+
>>> column.transform(lambda cell: cell / 2)
+---------+
| example |
|     --- |
|     f64 |
+=========+
| 3.00000 |
| 4.00000 |
+---------+
Source code in src/safeds/data/tabular/containers/_cell.py
def div(self, other: Any) -> Cell[R_co]:
    """
    Divide by a value. This is equivalent to the `/` operator.

    Examples
    --------
    >>> from safeds.data.tabular.containers import Column
    >>> column = Column("example", [6, 8])
    >>> column.transform(lambda cell: cell.div(2))
    +---------+
    | example |
    |     --- |
    |     f64 |
    +=========+
    | 3.00000 |
    | 4.00000 |
    +---------+

    >>> column.transform(lambda cell: cell / 2)
    +---------+
    | example |
    |     --- |
    |     f64 |
    +=========+
    | 3.00000 |
    | 4.00000 |
    +---------+
    """
    return self.__truediv__(other)

eq

Check if equal to a value. This is equivalent to the == operator.

Examples:

>>> from safeds.data.tabular.containers import Column
>>> column = Column("example", [1, 2])
>>> column.transform(lambda cell: cell.eq(2))
+---------+
| example |
| ---     |
| bool    |
+=========+
| false   |
| true    |
+---------+
>>> column.transform(lambda cell: cell == 2)
+---------+
| example |
| ---     |
| bool    |
+=========+
| false   |
| true    |
+---------+
Source code in src/safeds/data/tabular/containers/_cell.py
def eq(self, other: Any) -> Cell[bool]:
    """
    Check if equal to a value. This is equivalent to the `==` operator.

    Examples
    --------
    >>> from safeds.data.tabular.containers import Column
    >>> column = Column("example", [1, 2])
    >>> column.transform(lambda cell: cell.eq(2))
    +---------+
    | example |
    | ---     |
    | bool    |
    +=========+
    | false   |
    | true    |
    +---------+

    >>> column.transform(lambda cell: cell == 2)
    +---------+
    | example |
    | ---     |
    | bool    |
    +=========+
    | false   |
    | true    |
    +---------+
    """
    return self.__eq__(other)

first_not_none

Return the first cell from the given list that is not None.

Parameters:

Name Type Description Default
cells list[Cell]

The list of cells to be searched.

required

Returns:

Name Type Description
cell Cell

Returns the contents of the first cell that is not None. If all cells in the list are None or the list is empty returns None.

Source code in src/safeds/data/tabular/containers/_cell.py
@staticmethod
def first_not_none(cells: list[Cell]) -> Cell:
    """
    Return the first cell from the given list that is not None.

    Parameters
    ----------
    cells:
        The list of cells to be searched.

    Returns
    -------
    cell:
        Returns the contents of the first cell that is not None.
        If all cells in the list are None or the list is empty returns None.
    """
    import polars as pl

    from ._lazy_cell import _LazyCell  # circular import

    return _LazyCell(pl.coalesce([cell._polars_expression for cell in cells]))

floor

Round down to the nearest integer.

Examples:

>>> from safeds.data.tabular.containers import Column
>>> column = Column("example", [1.1, 2.9])
>>> column.transform(lambda cell: cell.floor())
+---------+
| example |
|     --- |
|     f64 |
+=========+
| 1.00000 |
| 2.00000 |
+---------+
Source code in src/safeds/data/tabular/containers/_cell.py
def floor(self) -> Cell[R_co]:
    """
    Round down to the nearest integer.

    Examples
    --------
    >>> from safeds.data.tabular.containers import Column
    >>> column = Column("example", [1.1, 2.9])
    >>> column.transform(lambda cell: cell.floor())
    +---------+
    | example |
    |     --- |
    |     f64 |
    +=========+
    | 1.00000 |
    | 2.00000 |
    +---------+
    """
    return self.__floor__()

ge

Check if greater than or equal to a value. This is equivalent to the >= operator.

Examples:

>>> from safeds.data.tabular.containers import Column
>>> column = Column("example", [1, 2])
>>> column.transform(lambda cell: cell.ge(2))
+---------+
| example |
| ---     |
| bool    |
+=========+
| false   |
| true    |
+---------+
>>> column.transform(lambda cell: cell >= 2)
+---------+
| example |
| ---     |
| bool    |
+=========+
| false   |
| true    |
+---------+
Source code in src/safeds/data/tabular/containers/_cell.py
def ge(self, other: Any) -> Cell[bool]:
    """
    Check if greater than or equal to a value. This is equivalent to the `>=` operator.

    Examples
    --------
    >>> from safeds.data.tabular.containers import Column
    >>> column = Column("example", [1, 2])
    >>> column.transform(lambda cell: cell.ge(2))
    +---------+
    | example |
    | ---     |
    | bool    |
    +=========+
    | false   |
    | true    |
    +---------+

    >>> column.transform(lambda cell: cell >= 2)
    +---------+
    | example |
    | ---     |
    | bool    |
    +=========+
    | false   |
    | true    |
    +---------+
    """
    return self.__ge__(other)

gt

Check if greater than a value. This is equivalent to the > operator.

Examples:

>>> from safeds.data.tabular.containers import Column
>>> column = Column("example", [1, 2])
>>> column.transform(lambda cell: cell.gt(2))
+---------+
| example |
| ---     |
| bool    |
+=========+
| false   |
| false   |
+---------+
>>> column.transform(lambda cell: cell > 2)
+---------+
| example |
| ---     |
| bool    |
+=========+
| false   |
| false   |
+---------+
Source code in src/safeds/data/tabular/containers/_cell.py
def gt(self, other: Any) -> Cell[bool]:
    """
    Check if greater than a value. This is equivalent to the `>` operator.

    Examples
    --------
    >>> from safeds.data.tabular.containers import Column
    >>> column = Column("example", [1, 2])
    >>> column.transform(lambda cell: cell.gt(2))
    +---------+
    | example |
    | ---     |
    | bool    |
    +=========+
    | false   |
    | false   |
    +---------+

    >>> column.transform(lambda cell: cell > 2)
    +---------+
    | example |
    | ---     |
    | bool    |
    +=========+
    | false   |
    | false   |
    +---------+
    """
    return self.__gt__(other)

le

Check if less than or equal to a value. This is equivalent to the <= operator.

Examples:

>>> from safeds.data.tabular.containers import Column
>>> column = Column("example", [1, 2])
>>> column.transform(lambda cell: cell.le(2))
+---------+
| example |
| ---     |
| bool    |
+=========+
| true    |
| true    |
+---------+
>>> column.transform(lambda cell: cell <= 2)
+---------+
| example |
| ---     |
| bool    |
+=========+
| true    |
| true    |
+---------+
Source code in src/safeds/data/tabular/containers/_cell.py
def le(self, other: Any) -> Cell[bool]:
    """
    Check if less than or equal to a value. This is equivalent to the `<=` operator.

    Examples
    --------
    >>> from safeds.data.tabular.containers import Column
    >>> column = Column("example", [1, 2])
    >>> column.transform(lambda cell: cell.le(2))
    +---------+
    | example |
    | ---     |
    | bool    |
    +=========+
    | true    |
    | true    |
    +---------+

    >>> column.transform(lambda cell: cell <= 2)
    +---------+
    | example |
    | ---     |
    | bool    |
    +=========+
    | true    |
    | true    |
    +---------+
    """
    return self.__le__(other)

lt

Check if less than a value. This is equivalent to the < operator.

Examples:

>>> from safeds.data.tabular.containers import Column
>>> column = Column("example", [1, 2])
>>> column.transform(lambda cell: cell.lt(2))
+---------+
| example |
| ---     |
| bool    |
+=========+
| true    |
| false   |
+---------+
>>> column.transform(lambda cell: cell < 2)
+---------+
| example |
| ---     |
| bool    |
+=========+
| true    |
| false   |
+---------+
Source code in src/safeds/data/tabular/containers/_cell.py
def lt(self, other: Any) -> Cell[bool]:
    """
    Check if less than a value. This is equivalent to the `<` operator.

    Examples
    --------
    >>> from safeds.data.tabular.containers import Column
    >>> column = Column("example", [1, 2])
    >>> column.transform(lambda cell: cell.lt(2))
    +---------+
    | example |
    | ---     |
    | bool    |
    +=========+
    | true    |
    | false   |
    +---------+

    >>> column.transform(lambda cell: cell < 2)
    +---------+
    | example |
    | ---     |
    | bool    |
    +=========+
    | true    |
    | false   |
    +---------+
    """
    return self.__lt__(other)

mod

Perform a modulo operation. This is equivalent to the % operator.

Examples:

>>> from safeds.data.tabular.containers import Column
>>> column = Column("example", [5, 6])
>>> column.transform(lambda cell: cell.mod(3))
+---------+
| example |
|     --- |
|     i64 |
+=========+
|       2 |
|       0 |
+---------+
>>> column.transform(lambda cell: cell % 3)
+---------+
| example |
|     --- |
|     i64 |
+=========+
|       2 |
|       0 |
+---------+
Source code in src/safeds/data/tabular/containers/_cell.py
def mod(self, other: Any) -> Cell[R_co]:
    """
    Perform a modulo operation. This is equivalent to the `%` operator.

    Examples
    --------
    >>> from safeds.data.tabular.containers import Column
    >>> column = Column("example", [5, 6])
    >>> column.transform(lambda cell: cell.mod(3))
    +---------+
    | example |
    |     --- |
    |     i64 |
    +=========+
    |       2 |
    |       0 |
    +---------+

    >>> column.transform(lambda cell: cell % 3)
    +---------+
    | example |
    |     --- |
    |     i64 |
    +=========+
    |       2 |
    |       0 |
    +---------+
    """
    return self.__mod__(other)

mul

Multiply by a value. This is equivalent to the * operator.

Examples:

>>> from safeds.data.tabular.containers import Column
>>> column = Column("example", [2, 3])
>>> column.transform(lambda cell: cell.mul(4))
+---------+
| example |
|     --- |
|     i64 |
+=========+
|       8 |
|      12 |
+---------+
>>> column.transform(lambda cell: cell * 4)
+---------+
| example |
|     --- |
|     i64 |
+=========+
|       8 |
|      12 |
+---------+
Source code in src/safeds/data/tabular/containers/_cell.py
def mul(self, other: Any) -> Cell[R_co]:
    """
    Multiply by a value. This is equivalent to the `*` operator.

    Examples
    --------
    >>> from safeds.data.tabular.containers import Column
    >>> column = Column("example", [2, 3])
    >>> column.transform(lambda cell: cell.mul(4))
    +---------+
    | example |
    |     --- |
    |     i64 |
    +=========+
    |       8 |
    |      12 |
    +---------+

    >>> column.transform(lambda cell: cell * 4)
    +---------+
    | example |
    |     --- |
    |     i64 |
    +=========+
    |       8 |
    |      12 |
    +---------+
    """
    return self.__mul__(other)

neg

Negate the value.

Examples:

>>> from safeds.data.tabular.containers import Column
>>> column = Column("example", [1, -2])
>>> column.transform(lambda cell: cell.neg())
+---------+
| example |
|     --- |
|     i64 |
+=========+
|      -1 |
|       2 |
+---------+
Source code in src/safeds/data/tabular/containers/_cell.py
def neg(self) -> Cell[R_co]:
    """
    Negate the value.

    Examples
    --------
    >>> from safeds.data.tabular.containers import Column
    >>> column = Column("example", [1, -2])
    >>> column.transform(lambda cell: cell.neg())
    +---------+
    | example |
    |     --- |
    |     i64 |
    +=========+
    |      -1 |
    |       2 |
    +---------+
    """
    return self.__neg__()

neq

Check if not equal to a value. This is equivalent to the != operator.

Examples:

>>> from safeds.data.tabular.containers import Column
>>> column = Column("example", [1, 2])
>>> column.transform(lambda cell: cell.neq(2))
+---------+
| example |
| ---     |
| bool    |
+=========+
| true    |
| false   |
+---------+
>>> column.transform(lambda cell: cell != 2)
+---------+
| example |
| ---     |
| bool    |
+=========+
| true    |
| false   |
+---------+
Source code in src/safeds/data/tabular/containers/_cell.py
def neq(self, other: Any) -> Cell[bool]:
    """
    Check if not equal to a value. This is equivalent to the `!=` operator.

    Examples
    --------
    >>> from safeds.data.tabular.containers import Column
    >>> column = Column("example", [1, 2])
    >>> column.transform(lambda cell: cell.neq(2))
    +---------+
    | example |
    | ---     |
    | bool    |
    +=========+
    | true    |
    | false   |
    +---------+

    >>> column.transform(lambda cell: cell != 2)
    +---------+
    | example |
    | ---     |
    | bool    |
    +=========+
    | true    |
    | false   |
    +---------+
    """
    return self.__ne__(other)

not_

Negate a boolean. This is equivalent to the ~ operator.

Examples:

>>> from safeds.data.tabular.containers import Column
>>> column = Column("example", [True, False])
>>> column.transform(lambda cell: cell.not_())
+---------+
| example |
| ---     |
| bool    |
+=========+
| false   |
| true    |
+---------+
>>> column.transform(lambda cell: ~cell)
+---------+
| example |
| ---     |
| bool    |
+=========+
| false   |
| true    |
+---------+
Source code in src/safeds/data/tabular/containers/_cell.py
def not_(self) -> Cell[bool]:
    """
    Negate a boolean. This is equivalent to the `~` operator.

    Examples
    --------
    >>> from safeds.data.tabular.containers import Column
    >>> column = Column("example", [True, False])
    >>> column.transform(lambda cell: cell.not_())
    +---------+
    | example |
    | ---     |
    | bool    |
    +=========+
    | false   |
    | true    |
    +---------+

    >>> column.transform(lambda cell: ~cell)
    +---------+
    | example |
    | ---     |
    | bool    |
    +=========+
    | false   |
    | true    |
    +---------+
    """
    return self.__invert__()

or_

Perform a boolean OR operation. This is equivalent to the | operator.

Examples:

>>> from safeds.data.tabular.containers import Column
>>> column = Column("example", [True, False])
>>> column.transform(lambda cell: cell.or_(True))
+---------+
| example |
| ---     |
| bool    |
+=========+
| true    |
| true    |
+---------+
>>> column.transform(lambda cell: cell | True)
+---------+
| example |
| ---     |
| bool    |
+=========+
| true    |
| true    |
+---------+
Source code in src/safeds/data/tabular/containers/_cell.py
def or_(self, other: bool | Cell[bool]) -> Cell[bool]:
    """
    Perform a boolean OR operation. This is equivalent to the `|` operator.

    Examples
    --------
    >>> from safeds.data.tabular.containers import Column
    >>> column = Column("example", [True, False])
    >>> column.transform(lambda cell: cell.or_(True))
    +---------+
    | example |
    | ---     |
    | bool    |
    +=========+
    | true    |
    | true    |
    +---------+

    >>> column.transform(lambda cell: cell | True)
    +---------+
    | example |
    | ---     |
    | bool    |
    +=========+
    | true    |
    | true    |
    +---------+
    """
    return self.__or__(other)

pow

Raise to a power. This is equivalent to the ** operator.

Examples:

>>> from safeds.data.tabular.containers import Column
>>> column = Column("example", [2, 3])
>>> column.transform(lambda cell: cell.pow(3))
+---------+
| example |
|     --- |
|     i64 |
+=========+
|       8 |
|      27 |
+---------+
>>> column.transform(lambda cell: cell ** 3)
+---------+
| example |
|     --- |
|     i64 |
+=========+
|       8 |
|      27 |
+---------+
Source code in src/safeds/data/tabular/containers/_cell.py
def pow(self, other: float | Cell[P_contra]) -> Cell[R_co]:
    """
    Raise to a power. This is equivalent to the `**` operator.

    Examples
    --------
    >>> from safeds.data.tabular.containers import Column
    >>> column = Column("example", [2, 3])
    >>> column.transform(lambda cell: cell.pow(3))
    +---------+
    | example |
    |     --- |
    |     i64 |
    +=========+
    |       8 |
    |      27 |
    +---------+

    >>> column.transform(lambda cell: cell ** 3)
    +---------+
    | example |
    |     --- |
    |     i64 |
    +=========+
    |       8 |
    |      27 |
    +---------+
    """
    return self.__pow__(other)

sub

Subtract a value. This is equivalent to the - operator.

Examples:

>>> from safeds.data.tabular.containers import Column
>>> column = Column("example", [5, 6])
>>> column.transform(lambda cell: cell.sub(3))
+---------+
| example |
|     --- |
|     i64 |
+=========+
|       2 |
|       3 |
+---------+
>>> column.transform(lambda cell: cell - 3)
+---------+
| example |
|     --- |
|     i64 |
+=========+
|       2 |
|       3 |
+---------+
Source code in src/safeds/data/tabular/containers/_cell.py
def sub(self, other: Any) -> Cell[R_co]:
    """
    Subtract a value. This is equivalent to the `-` operator.

    Examples
    --------
    >>> from safeds.data.tabular.containers import Column
    >>> column = Column("example", [5, 6])
    >>> column.transform(lambda cell: cell.sub(3))
    +---------+
    | example |
    |     --- |
    |     i64 |
    +=========+
    |       2 |
    |       3 |
    +---------+

    >>> column.transform(lambda cell: cell - 3)
    +---------+
    | example |
    |     --- |
    |     i64 |
    +=========+
    |       2 |
    |       3 |
    +---------+
    """
    return self.__sub__(other)

xor

Perform a boolean XOR operation. This is equivalent to the ^ operator.

Examples:

>>> from safeds.data.tabular.containers import Column
>>> column = Column("example", [True, False])
>>> column.transform(lambda cell: cell.xor(True))
+---------+
| example |
| ---     |
| bool    |
+=========+
| false   |
| true    |
+---------+
>>> column.transform(lambda cell: cell ^ True)
+---------+
| example |
| ---     |
| bool    |
+=========+
| false   |
| true    |
+---------+
Source code in src/safeds/data/tabular/containers/_cell.py
def xor(self, other: bool | Cell[bool]) -> Cell[bool]:
    """
    Perform a boolean XOR operation. This is equivalent to the `^` operator.

    Examples
    --------
    >>> from safeds.data.tabular.containers import Column
    >>> column = Column("example", [True, False])
    >>> column.transform(lambda cell: cell.xor(True))
    +---------+
    | example |
    | ---     |
    | bool    |
    +=========+
    | false   |
    | true    |
    +---------+

    >>> column.transform(lambda cell: cell ^ True)
    +---------+
    | example |
    | ---     |
    | bool    |
    +=========+
    | false   |
    | true    |
    +---------+
    """
    return self.__xor__(other)