Teradata Package for Python Function Reference - 17.00 - log - Teradata Package for Python

Teradata® Package for Python Function Reference

Product
Teradata Package for Python
Release Number
17.00
Release Date
April 2021
Content Type
Programming Reference
Publication ID
B700-4008-070K
Language
English (United States)
 
 
log

 
Functions
       
log(column_expression_or_constant)
DESCRIPTION:
    Function returns the base 10 logarithm of an argument.
 
PARAMETERS:
    column_expression_or_constant:
        Required Argument.
        Specifies a ColumnExpression of a column containing numeric values or a numeric constant
        to compute the base 10 logarithm.
        Format for the argument: '<dataframe>.<dataframe_column>.expression'.
 
        Notes:
            1. If the type of the column/argument is not FLOAT, column values are converted to FLOAT
               based on implicit type conversion rules. If an argument cannot be converted, an
               error is reported. For more information on implicit type conversion,
               see Teradata Vantage™ Data Types and Literals, B035-1143.
            2. Unsupported column types:
                a. BYTE or VARBYTE
                b. LOBs (BLOB or CLOB)
                c. CHARACTER or VARCHAR if the server character set is GRAPHIC
 
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
    >>>
 
    # Example computes logarithm of values in "gpa" * 10 and a constant 10.
    # Import func from sqlalchemy to execute log() function.
    >>> from sqlalchemy import func
 
    # Create a sqlalchemy Function object and pass the Function object as input to DataFrame.assign().
    # Note: We are using 'log' and 'LOG' as function names. Function names are case-insensitive.
    >>> df = admissions_train.assign(log_gpa_func_ = func.LOG(admissions_train.gpa.expression * 10),
    ...                              log_const_func = func.log(10))
    >>> print(df)
       masters   gpa     stats programming  admitted  log_const_func  log_gpa_func_
    id
    22     yes  3.46    Novice    Beginner         0             1.0       1.539076
    36      no  3.00  Advanced      Novice         0             1.0       1.477121
    15     yes  4.00  Advanced    Advanced         1             1.0       1.602060
    38     yes  2.65  Advanced    Beginner         1             1.0       1.423246
    5       no  3.44    Novice      Novice         0             1.0       1.536558
    17      no  3.83  Advanced    Advanced         1             1.0       1.583199
    34     yes  3.85  Advanced    Beginner         0             1.0       1.585461
    13      no  4.00  Advanced      Novice         1             1.0       1.602060
    26     yes  3.57  Advanced    Advanced         1             1.0       1.552668
    19     yes  1.98  Advanced    Advanced         0             1.0       1.296665
    >>>