teradataml.dataframe.sql.DataFrameColumn.csum = csum(sort_columns)

DESCRIPTION:
    Returns cumulative sum value for rows in ColumnExpression, over the
    partition specified by "sort_columns".
    Note:
        csum does not support below type of columns.
            * BLOB
            * BYTE
            * CHAR
            * CLOB
            * DATE
            * PERIOD_DATE
            * PERIOD_TIME
            * PERIOD_TIMESTAMP
            * TIME
            * TIMESTAMP
            * VARBYTE
            * VARCHAR
 
PARAMETERS:
    sort_columns:
        Required Argument.
        Specifies the columns to use for sorting.
        Note:
            "sort_columns" does not support CLOB and BLOB type of
            columns.
        Types: str (or) ColumnExpression (or) List of strings(str)
               or ColumnExpressions
 
RAISES:
    TeradataMlException, TypeError
 
RETURNS:
    ColumnExpression, also known as, teradataml DataFrameColumn.
 
NOTES:
    * One must use DataFrame.assign() when using the aggregate functions on
      ColumnExpression, also known as, teradataml DataFrameColumn.
    * ColumnExpression specified in "sort_columns" should be from the same
      teradataml DataFrame as that of the ColumnExpression invoking the function.
 
EXAMPLES:
    # Load the data to run the example.
    >>> from teradataml import load_example_data
    >>> load_example_data("dataframe","sales")
 
    # Create teradataml dataframe.
    >>> df = DataFrame.from_table('sales')
    >>> print(df)
                  Feb    Jan    Mar    Apr    datetime
    accounts
    Blue Inc     90.0   50.0   95.0  101.0  04/01/2017
    Orange Inc  210.0    NaN    NaN  250.0  04/01/2017
    Red Inc     200.0  150.0  140.0    NaN  04/01/2017
    Yellow Inc   90.0    NaN    NaN    NaN  04/01/2017
    Jones LLC   200.0  150.0  140.0  180.0  04/01/2017
    Alpha Co    210.0  200.0  215.0  250.0  04/01/2017
    >>>
 
    # Example 1: Calculate the cumulative sum of 'Feb' by sorting
    # data in column 'accounts' in ascending order.
    >>> df.assign(csum_feb=df.Feb.csum(df.accounts))
                  Feb    Jan    Mar    Apr    datetime  csum_feb
    accounts
    Jones LLC   200.0  150.0  140.0  180.0  04/01/2017     500.0
    Red Inc     200.0  150.0  140.0    NaN  04/01/2017     910.0
    Yellow Inc   90.0    NaN    NaN    NaN  04/01/2017    1000.0
    Orange Inc  210.0    NaN    NaN  250.0  04/01/2017     710.0
    Blue Inc     90.0   50.0   95.0  101.0  04/01/2017     300.0
    Alpha Co    210.0  200.0  215.0  250.0  04/01/2017     210.0
    >>>
 
    # Example 2: Calculate the cumulative sum of column 'Feb' by sorting
    # data in column 'Mar' in descending order and column 'accounts' in
    # ascending order.
    >>> df.assign(csum_feb=df.Feb.csum(sort_columns=[df.Mar.desc(), df.accounts]))
                  Feb    Jan    Mar    Apr    datetime  csum_feb
    accounts
    Red Inc     200.0  150.0  140.0    NaN  04/01/2017     610.0
    Orange Inc  210.0    NaN    NaN  250.0  04/01/2017     910.0
    Yellow Inc   90.0    NaN    NaN    NaN  04/01/2017    1000.0
    Blue Inc     90.0   50.0   95.0  101.0  04/01/2017     700.0
    Jones LLC   200.0  150.0  140.0  180.0  04/01/2017     410.0
    Alpha Co    210.0  200.0  215.0  250.0  04/01/2017     210.0