Loading...

vastorbit.VastColumn.sub

VastColumn.sub(x: Annotated[int | float | Decimal, 'Python Numbers']) VastFrame

Subtracts the input element from the VastColumn.

Parameters:

x (PythonNumber) – If the VastColumn type is date (date, datetime …), the parameter ‘x’ represents the number of seconds, otherwise it represents a number.

Returns:

self._parent

Return type:

VastFrame

Examples

Let’s begin by importing vastorbit.

import vastorbit as vo

Hint

By assigning an alias to vastorbit, we mitigate the risk of code collisions with other libraries. This precaution is necessary because vastorbit uses commonly known function names like “average” and “median”, which can potentially lead to naming conflicts. The use of an alias ensures that the functions from vastorbit are used as intended without interfering with functions from other libraries.

Let us create a dummy dataset with negative values:

vdf = vo.VastFrame({"val" : [10, -10, 20, -2]})
123
val
Integer
110
2-2
320
4-10
Rows: 1-4 | Column: val | Type: integer

We can conveniently substract 5 from all the values in a column:

vdf["val"].sub(5)
123
val
Integer
1-15
2-7
35
415
Rows: 1-4 | Column: val | Type: integer

Note

While the same task can be accomplished using pure SQL (see below), adopting a Pythonic approach can offer greater convenience and help avoid potential syntax errors.

vdf["val"] = "val - 5"

See also

VastColumn.mul() : Multiply the VastColumn by a value.
VastColumn.add() : Add a value to the entire VastColumn.