teradataml.dataframe.sql.DataFrameColumn.array_add = array_add(self, other, lower_bound=None, upper_bound=None)

DESCRIPTION:
    Add the elements of the array with another array or scalar value
    element-wise and return the resultant array.
 
PARAMETERS:
    other:
        Required Argument.
        Specifies the array or Python literal value to add.
        Note:
            * Value specified in "other" must be of the same type as the array to add.
        Types: ColumnExpression OR Python literal
 
    lower_bound:
        Optional Argument.
        Specifies the starting index for addition (inclusive).
        Note:
            * If specified, both "lower_bound" and "upper_bound" arguments must be provided.
        Types: int
 
    upper_bound:
        Optional Argument.
        Specifies the ending index for addition (inclusive).
        Note:
            * If specified, both "lower_bound" and "upper_bound" arguments must be provided.
        Types: int
 
RETURNS:
    ColumnExpression
 
EXAMPLES:
    >>> from teradataml import *
    >>> load_example_data("array", "array_table")
 
    # Create a DataFrame on 'array_table'.
    >>> df = DataFrame("array_table")
    >>> df
                     arr1                   arr2                        arr3
    id                                                                      
    1    (10,20,30,40,50)     (23,200,215,40,21)  ('ab','bc','cd','ab','ef')
    4   (180,28,38,48,58)  (30,NULL,NULL,250,27)  ('mn','no',NULL,'op','pq')
    2   (150,25,35,45,55)       (28,50,95,90,26)  ('xy','yz','za','ab','xy')
    6   (16,261,36,46,56)     (29,170,160,46,25)  ('uv','xy','ab','xy','yz')
    3   (12,22,320,42,52)     (25,22,140,200,23)  ('pq','ab','ab','st','tu')
    5    (14,24,34,44,54)  (26,NULL,NULL,180,24)  ('ij','jk',NULL,'kl','lm')
 
    # Example 1: Add corresponding elements of array columns 'arr1' and 'arr2'.
    >>> res = df.assign(add_res = df.arr1.array_add(df.arr2))
    >>> res
                     arr1                   arr2                        arr3                 add_res
    id                                                                                              
    1    (10,20,30,40,50)     (23,200,215,40,21)  ('ab','bc','cd','ab','ef')      (33,220,245,80,71)
    4   (180,28,38,48,58)  (30,NULL,NULL,250,27)  ('mn','no',NULL,'op','pq')  (210,NULL,NULL,298,85)
    2   (150,25,35,45,55)       (28,50,95,90,26)  ('xy','yz','za','ab','xy')     (178,75,130,135,81)
    6   (16,261,36,46,56)     (29,170,160,46,25)  ('uv','xy','ab','xy','yz')      (45,431,196,92,81)
    3   (12,22,320,42,52)     (25,22,140,200,23)  ('pq','ab','ab','st','tu')      (37,44,460,242,75)
    5    (14,24,34,44,54)  (26,NULL,NULL,180,24)  ('ij','jk',NULL,'kl','ab')   (40,NULL,NULL,224,78)
 
    # Example 2: Add a scalar value 10 to all elements in array column 'arr1'.
    >>> res = df.assign(add_res = df.arr1.array_add(10))
    >>> res
                     arr1                   arr2                        arr3            add_res
    id                                                                                         
    1    (10,20,30,40,50)     (23,200,215,40,21)  ('ab','bc','cd','ab','ef')   (20,30,40,50,60)
    4   (180,28,38,48,58)  (30,NULL,NULL,250,27)  ('mn','no',NULL,'op','pq')  (190,38,48,58,68)
    2   (150,25,35,45,55)       (28,50,95,90,26)  ('xy','yz','za','ab','xy')  (160,35,45,55,65)
    6   (16,261,36,46,56)     (29,170,160,46,25)  ('uv','xy','ab','xy','yz')  (26,271,46,56,66)
    3   (12,22,320,42,52)     (25,22,140,200,23)  ('pq','ab','ab','st','tu')  (22,32,330,52,62)
    5    (14,24,34,44,54)  (26,NULL,NULL,180,24)  ('ij','jk',NULL,'kl','ab')   (24,34,44,54,64)
 
    # Example 3: Add a scalar value 5 to the elements present in first position to third position
    #            in the array column 'arr1'.
    >>> res = df.assign(add_res = df.arr1.array_add(5, lower_bound=1, upper_bound=3))
    >>> res
                arr1                   arr2                        arr3                    add_res
    id                                                                                                 
    1    (10,20,30,40,50)     (23,200,215,40,21)  ('ab','bc','cd','ab','ef')   (15,25,35,NULL,NULL)
    4   (180,28,38,48,58)  (30,NULL,NULL,250,27)  ('mn','no',NULL,'op','pq')  (185,33,43,NULL,NULL)
    2   (150,25,35,45,55)       (28,50,95,90,26)  ('xy','yz','za','ab','xy')  (155,30,40,NULL,NULL)
    6   (16,261,36,46,56)     (29,170,160,46,25)  ('uv','xy','ab','xy','yz')  (21,266,41,NULL,NULL)
    3   (12,22,320,42,52)     (25,22,140,200,23)  ('pq','ab','ab','st','tu')  (17,27,325,NULL,NULL)
    5    (14,24,34,44,54)  (26,NULL,NULL,180,24)  ('ij','jk',NULL,'kl','ab')   (19,29,39,NULL,NULL)
 
    # Example 4: Add the elements present in second position to fourth position in the array column
    #            'arr1' to the corresponding elements in array column 'arr2'.
    >>> res = df.assign(add_res = df.arr1.array_add(df.arr2, lower_bound=2, upper_bound=4))
    >>> res
                    arr1                   arr2                        arr3                    add_res
    id                                                                                                 
    1    (10,20,30,40,50)     (23,200,215,40,21)  ('ab','bc','cd','ab','ef')     (NULL,220,245,80,NULL)
    4   (180,28,38,48,58)  (30,NULL,NULL,250,27)  ('mn','no',NULL,'op','pq')  (NULL,NULL,NULL,298,NULL)
    2   (150,25,35,45,55)       (28,50,95,90,26)  ('xy','yz','za','ab','xy')     (NULL,75,130,135,NULL)
    6   (16,261,36,46,56)     (29,170,160,46,25)  ('uv','xy','ab','xy','yz')     (NULL,431,196,92,NULL)
    3   (12,22,320,42,52)     (25,22,140,200,23)  ('pq','ab','ab','st','tu')     (NULL,44,460,242,NULL)
    5    (14,24,34,44,54)  (26,NULL,NULL,180,24)  ('ij','jk',NULL,'kl','ab')  (NULL,NULL,NULL,224,NULL)