| | |
- round(column_expression_or_constant1, column_expression_or_constant2)
- DESCRIPTION:
Function returns numeric value (column_expression_or_constant1) rounded by the
places_value (column_expression_or_constant2) number of places to the right or
left of the decimal point.
ROUND functions as follows:
* 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.
* ROUND rounds the value away from zero and it only rounds when the next digit is
a value of 5 or greater.
PARAMETERS:
column_expression_or_constant1:
Required Argument.
Specifies a ColumnExpression of a numeric column or a numeric constant value that
is the numeric value to be rounded.
Format for the argument: '<dataframe>.<dataframe_column>.expression'.
column_expression_or_constant2:
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>.expression'.
NOTE:
Function accepts positional arguments only.
EXAMPLES:
# Load the data to run the example.
>>> load_example_data("dataframe", "admissions_train")
>>>
# Create a DataFrame on 'admissions_train' table.
>>> admissions_train = DataFrame("admissions_train")
>>> admissions_train
masters gpa stats programming admitted
id
22 yes 3.46 Novice Beginner 0
36 no 3.00 Advanced Novice 0
15 yes 4.00 Advanced Advanced 1
38 yes 2.65 Advanced Beginner 1
5 no 3.44 Novice Novice 0
17 no 3.83 Advanced Advanced 1
34 yes 3.85 Advanced Beginner 0
13 no 4.00 Advanced Novice 1
26 yes 3.57 Advanced Advanced 1
19 yes 1.98 Advanced Advanced 0
>>>
# Import func from sqlalchemy to execute round() function.
>>> from sqlalchemy import func
# Create a sqlalchemy Function object and pass the Function object as input to DataFrame.assign().
>>> df = admissions_train.assign(round_gpa_1 = func.Round(admissions_train.gpa.expression, 1),
... round_gpa_admitted = func.round(admissions_train.gpa.expression, admissions_train.admitted.expression),
... round_const_3 = func.ROUND(2.433412, 3))
>>> print(df)
masters gpa stats programming admitted round_const_3 round_gpa_1 round_gpa_admitted
id
22 yes 3.46 Novice Beginner 0 2.433 3.5 3.0
36 no 3.00 Advanced Novice 0 2.433 3.0 3.0
15 yes 4.00 Advanced Advanced 1 2.433 4.0 4.0
38 yes 2.65 Advanced Beginner 1 2.433 2.6 2.6
5 no 3.44 Novice Novice 0 2.433 3.4 3.0
17 no 3.83 Advanced Advanced 1 2.433 3.8 3.8
34 yes 3.85 Advanced Beginner 0 2.433 3.9 4.0
13 no 4.00 Advanced Novice 1 2.433 4.0 4.0
26 yes 3.57 Advanced Advanced 1 2.433 3.6 3.6
19 yes 1.98 Advanced Advanced 0 2.433 2.0 2.0
>>>
|