e52fcc0800a294a82c2c3d1d8ba5e43ee113e1c5
[hive.git] / ql / src / gen / vectorization / ExpressionTemplates / ColumnArithmeticColumn.txt
1 /**
2  * Licensed to the Apache Software Foundation (ASF) under one
3  * or more contributor license agreements.  See the NOTICE file
4  * distributed with this work for additional information
5  * regarding copyright ownership.  The ASF licenses this file
6  * to you under the Apache License, Version 2.0 (the
7  * "License"); you may not use this file except in compliance
8  * with the License.  You may obtain a copy of the License at
9  *
10  *     http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  */
18  
19 package org.apache.hadoop.hive.ql.exec.vector.expressions.gen;
20
21 import org.apache.hadoop.hive.ql.exec.vector.expressions.VectorExpression;
22 import org.apache.hadoop.hive.ql.exec.vector.expressions.NullUtil;
23 import org.apache.hadoop.hive.ql.exec.vector.*;
24 import org.apache.hadoop.hive.ql.exec.vector.VectorizedRowBatch;
25 import org.apache.hadoop.hive.ql.exec.vector.VectorExpressionDescriptor;
26
27 /**
28  * Generated from template ColumnArithmeticColumn.txt, which covers binary arithmetic 
29  * expressions between columns.
30  */
31 public class <ClassName> extends VectorExpression {
32
33   private static final long serialVersionUID = 1L;
34   
35   private int colNum1;
36   private int colNum2;
37   private int outputColumn;
38
39   public <ClassName>(int colNum1, int colNum2, int outputColumn) {
40     this.colNum1 = colNum1;
41     this.colNum2 = colNum2;
42     this.outputColumn = outputColumn;
43   }
44
45   public <ClassName>() {
46   }
47
48   @Override
49   public void evaluate(VectorizedRowBatch batch) {
50
51     if (childExpressions != null) {
52       super.evaluateChildren(batch);
53     }
54
55     <InputColumnVectorType1> inputColVector1 = (<InputColumnVectorType1>) batch.cols[colNum1];
56     <InputColumnVectorType2> inputColVector2 = (<InputColumnVectorType2>) batch.cols[colNum2];
57     <OutputColumnVectorType> outputColVector = (<OutputColumnVectorType>) batch.cols[outputColumn];
58     int[] sel = batch.selected;
59     int n = batch.size;
60     <OperandType1>[] vector1 = inputColVector1.vector;
61     <OperandType2>[] vector2 = inputColVector2.vector;
62     <ReturnType>[] outputVector = outputColVector.vector;
63     
64     // return immediately if batch is empty
65     if (n == 0) {
66       return;
67     }
68     
69     outputColVector.isRepeating = 
70          inputColVector1.isRepeating && inputColVector2.isRepeating
71       || inputColVector1.isRepeating && !inputColVector1.noNulls && inputColVector1.isNull[0]
72       || inputColVector2.isRepeating && !inputColVector2.noNulls && inputColVector2.isNull[0];
73     
74     // Handle nulls first  
75     NullUtil.propagateNullsColCol(
76       inputColVector1, inputColVector2, outputColVector, sel, n, batch.selectedInUse);
77           
78     /* Disregard nulls for processing. In other words,
79      * the arithmetic operation is performed even if one or 
80      * more inputs are null. This is to improve speed by avoiding
81      * conditional checks in the inner loop.
82      */ 
83     if (inputColVector1.isRepeating && inputColVector2.isRepeating) { 
84       outputVector[0] = vector1[0] <OperatorSymbol> vector2[0];
85     } else if (inputColVector1.isRepeating) {
86       final <OperandType1> vector1Value = vector1[0];
87       if (batch.selectedInUse) {
88         for(int j = 0; j != n; j++) {
89           int i = sel[j];
90           outputVector[i] = vector1Value <OperatorSymbol> vector2[i];
91         }
92       } else {
93         for(int i = 0; i != n; i++) {
94           outputVector[i] = vector1Value <OperatorSymbol> vector2[i];
95         }
96       }
97     } else if (inputColVector2.isRepeating) {
98       final <OperandType2> vector2Value = vector2[0];
99       if (batch.selectedInUse) {
100         for(int j = 0; j != n; j++) {
101           int i = sel[j];
102           outputVector[i] = vector1[i] <OperatorSymbol> vector2Value;
103         }
104       } else {
105         for(int i = 0; i != n; i++) {
106           outputVector[i] = vector1[i] <OperatorSymbol> vector2Value;
107         }
108       }
109     } else {
110       if (batch.selectedInUse) {
111         for(int j = 0; j != n; j++) {
112           int i = sel[j];
113           outputVector[i] = vector1[i] <OperatorSymbol> vector2[i];
114         }
115       } else {
116         for(int i = 0; i != n; i++) {
117           outputVector[i] = vector1[i] <OperatorSymbol>  vector2[i];
118         }
119       }
120     }
121     
122     /* For the case when the output can have null values, follow 
123      * the convention that the data values must be 1 for long and 
124      * NaN for double. This is to prevent possible later zero-divide errors
125      * in complex arithmetic expressions like col2 / (col1 - 1)
126      * in the case when some col1 entries are null.
127      */
128     NullUtil.setNullDataEntries<CamelReturnType>(outputColVector, batch.selectedInUse, sel, n);
129   }
130
131   @Override
132   public int getOutputColumn() {
133     return outputColumn;
134   }
135
136   @Override
137   public String getOutputType() {
138     return "<ReturnType>";
139   }
140   
141   public int getColNum1() {
142     return colNum1;
143   }
144
145   public void setColNum1(int colNum1) {
146     this.colNum1 = colNum1;
147   }
148
149   public int getColNum2() {
150     return colNum2;
151   }
152
153   public void setColNum2(int colNum2) {
154     this.colNum2 = colNum2;
155   }
156
157   public void setOutputColumn(int outputColumn) {
158     this.outputColumn = outputColumn;
159   }
160   
161   @Override
162   public VectorExpressionDescriptor.Descriptor getDescriptor() {
163     return (new VectorExpressionDescriptor.Builder())
164         .setMode(
165             VectorExpressionDescriptor.Mode.PROJECTION)
166         .setNumArguments(2)
167         .setArgumentTypes(
168             VectorExpressionDescriptor.ArgumentType.getType("<OperandType1>"),
169             VectorExpressionDescriptor.ArgumentType.getType("<OperandType2>"))
170         .setInputExpressionTypes(
171             VectorExpressionDescriptor.InputExpressionType.COLUMN,
172             VectorExpressionDescriptor.InputExpressionType.COLUMN).build();
173   }
174 }