Teradata Package for Python Function Reference | 20.00 - round - Teradata Package for Python - Look here for syntax, methods and examples for the functions included in the Teradata Package for Python.
Teradata® Package for Python Function Reference - 20.00
- Deployment
- VantageCloud
- VantageCore
- Edition
- Enterprise
- IntelliFlex
- VMware
- Product
- Teradata Package for Python
- Release Number
- 20.00.00.03
- Published
- December 2024
- ft:locale
- en-US
- ft:lastEdition
- 2024-12-19
- dita:id
- TeradataPython_FxRef_Enterprise_2000
- lifecycle
- latest
- Product Category
- Teradata Vantage
- teradataml.dataframe.sql.DataFrameColumn.round = round(expression)
- DESCRIPTION:
Function returns the value in the column rounded by the places_value (expression) number
of places to the right or left of the decimal point.
Notes:
* It rounds places_value places to the right of the decimal point if places_value
is positive.
* It rounds places_value places to the left of the decimal point if places_value
is negative.
* It rounds to 0 places if places_value is zero or is omitted.
* If numeric_value or places_value is NULL, the function returns NULL.
* It rounds the value away from zero, and it only rounds when the next digit is
a value of 5 or greater.
PARAMETERS:
expression:
Required Argument.
Specifies a ColumnExpression of a numeric column or a numeric constant value that
defines the number of places to round.
Format for the argument: '<dataframe>.<dataframe_column>'.
Types: ColumnExpression, int
RAISES:
TypeError, ValueError, TeradataMlException
RETURNS:
DataFrameColumn
EXAMPLES:
# Load the data to execute the example.
>>> load_example_data("dataframe", "admissions_train")
>>>
# Create a DataFrame on 'admissions_train' table.
>>> df = DataFrame("admissions_train").iloc[:4]
>>> print(df)
masters gpa stats programming admitted
id
3 no 3.70 Novice Beginner 1
4 yes 3.50 Beginner Novice 1
2 yes 3.76 Beginner Beginner 0
1 yes 3.95 Beginner Beginner 0
# Example 1: Execute the round() function and pass it as input to
# DataFrame.assign().
>>> res = df.assign(col_1 = df.gpa.round(1),
... col = df.gpa.round(df.admitted))
>>> print(res)
masters gpa stats programming admitted col col_1
id
3 no 3.70 Novice Beginner 1 3.7 3.7
4 yes 3.50 Beginner Novice 1 3.5 3.5
2 yes 3.76 Beginner Beginner 0 4.0 3.8
1 yes 3.95 Beginner Beginner 0 4.0 4.0
# Example 2: Executed round() function on "gpa" column and filtered computed values
# which are greater than 3.8.
>>> print(df[df.gpa.round(1) > 3.8])
masters gpa stats programming admitted
id
1 yes 3.95 Beginner Beginner 0