Teradata Package for Python Function Reference on VantageCloud Lake | 17.20 - acosh - 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 on VantageCloud Lake

Deployment
VantageCloud
Edition
Lake
Product
Teradata Package for Python
Release Number
17.20
Publication Date
November 2022
Content Type
Programming Reference
Publication ID
B700-4500-112K
ft:locale
en-US
ft:lastEdition
2024-02-21
ft:sourceId
FTML
dita:id
TeradataPython_FxRef_Lake_1720
Product Category
Teradata Vantage
 
 
acosh

 
Functions
       
acosh(column_expression)
DESCRIPTION:
    Function computes the inverse hyperbolic cosine value of an argument.
 
PARAMETERS:
    column_expression:
        Required Argument.
        Specifies a ColumnExpression of a numeric column or a numeric constant
        on which acosh() is requested.
        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.
            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 calculates inverse hyperbolic cosine value for the "gpa" column with help of SQLAlchemy.
    # Import func from sqlalchemy to execute acosh() function.
    >>> from sqlalchemy import func
 
    # Create a sqlalchemy Function object.
    >>> acosh_func_ = func.acosh(admissions_train.gpa.expression)
    >>>
 
    # Pass the Function object as input to DataFrame.assign().
    >>> df = admissions_train.assign(acosh_gpa_=acosh_func_)
    >>> print(df)
       masters   gpa     stats programming  admitted  acosh_gpa_
    id
    13      no  4.00  Advanced      Novice         1    2.063437
    26     yes  3.57  Advanced    Advanced         1    1.945493
    5       no  3.44    Novice      Novice         0    1.906790
    19     yes  1.98  Advanced    Advanced         0    1.305333
    15     yes  4.00  Advanced    Advanced         1    2.063437
    40     yes  3.95    Novice    Beginner         0    2.050440
    7      yes  2.33    Novice      Novice         1    1.489414
    22     yes  3.46    Novice    Beginner         0    1.912847
    36      no  3.00  Advanced      Novice         0    1.762747
    38     yes  2.65  Advanced    Beginner         1    1.630040
    >>>