2438ee47b7c147bf9cd2703247d8439eadc2f525
[hive.git] / ql / src / gen / vectorization / ExpressionTemplates / ColumnCompareScalar.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.<InputColumnVectorType>;
23 import org.apache.hadoop.hive.ql.exec.vector.<OutputColumnVectorType>;
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 ColumnCompareScalar.txt, which covers binary comparison 
29  * expressions between a column and a scalar. The boolean output is stored in a 
30  * separate boolean column.
31  */
32 public class <ClassName> extends VectorExpression {
33
34   private static final long serialVersionUID = 1L;
35
36   private int colNum;
37   private <OperandType2> value;
38   private int outputColumn;
39
40   public <ClassName>(int colNum, <OperandType2> value, int outputColumn) {
41     this.colNum = colNum;
42     this.value = value;
43     this.outputColumn = outputColumn;
44   }
45
46   public <ClassName>() {
47   }
48
49   @Override
50   public void evaluate(VectorizedRowBatch batch) {
51
52     if (childExpressions != null) {
53       super.evaluateChildren(batch);
54     }
55
56     <InputColumnVectorType> inputColVector = (<InputColumnVectorType>) batch.cols[colNum];
57     <OutputColumnVectorType> outputColVector = (<OutputColumnVectorType>) batch.cols[outputColumn];
58     int[] sel = batch.selected;
59     boolean[] nullPos = inputColVector.isNull;
60     boolean[] outNulls = outputColVector.isNull;
61     int n = batch.size;
62     <OperandType1>[] vector = inputColVector.vector;
63     <ReturnType>[] outputVector = outputColVector.vector;
64     
65     // return immediately if batch is empty
66     if (n == 0) {
67       return;
68     }
69
70     outputColVector.isRepeating = false;
71     outputColVector.noNulls = inputColVector.noNulls;
72     if (inputColVector.noNulls) {
73       if (inputColVector.isRepeating) {
74         //All must be selected otherwise size would be zero
75         //Repeating property will not change.
76         outputVector[0] = vector[0] <OperatorSymbol> value ? 1 : 0;
77         outputColVector.isRepeating = true;
78       } else if (batch.selectedInUse) {
79         for(int j=0; j != n; j++) {
80           int i = sel[j];
81           outputVector[i] = vector[i] <OperatorSymbol> value ? 1 : 0;
82         }
83       } else {
84         for(int i = 0; i != n; i++) {
85           outputVector[i] = vector[i] <OperatorSymbol> value ? 1 : 0;
86         }
87       }
88     } else {
89       if (inputColVector.isRepeating) {
90         //All must be selected otherwise size would be zero
91         //Repeating property will not change.
92         if (!nullPos[0]) {
93           outputVector[0] = vector[0] <OperatorSymbol> value ? 1 : 0;
94           outNulls[0] = false;
95         } else {
96           outNulls[0] = true;
97         }
98         outputColVector.isRepeating = true;
99       } else if (batch.selectedInUse) {
100         for(int j=0; j != n; j++) {
101           int i = sel[j];
102           if (!nullPos[i]) {
103             outputVector[i] = vector[i] <OperatorSymbol> value ? 1 : 0;
104             outNulls[i] = false;
105           } else {
106             //comparison with null is null
107             outNulls[i] = true;
108           }
109         }
110       } else {
111         System.arraycopy(nullPos, 0, outNulls, 0, n);
112         for(int i = 0; i != n; i++) {
113           if (!nullPos[i]) {
114             outputVector[i] = vector[i] <OperatorSymbol> value ? 1 : 0;
115           } 
116         }
117       }
118     }
119   }
120
121   @Override
122   public int getOutputColumn() {
123     return outputColumn;
124   }
125
126   @Override
127   public String getOutputType() {
128     return "<ReturnType>";
129   }
130   
131   public int getColNum() {
132     return colNum;
133   }
134   
135   public void setColNum(int colNum) {
136     this.colNum = colNum;
137   }
138
139   public <OperandType2> getValue() {
140     return value;
141   }
142
143   public void setValue(<OperandType2> value) {
144     this.value = value;
145   }
146
147   public void setOutputColumn(int outputColumn) {
148     this.outputColumn = outputColumn;
149   }
150
151   @Override
152   public VectorExpressionDescriptor.Descriptor getDescriptor() {
153     return (new VectorExpressionDescriptor.Builder())
154         .setMode(
155             VectorExpressionDescriptor.Mode.PROJECTION)
156         .setNumArguments(2)
157         .setArgumentTypes(
158             VectorExpressionDescriptor.ArgumentType.getType("<VectorExprArgType1>"),
159             VectorExpressionDescriptor.ArgumentType.getType("<VectorExprArgType2>"))
160         .setInputExpressionTypes(
161             VectorExpressionDescriptor.InputExpressionType.COLUMN,
162             VectorExpressionDescriptor.InputExpressionType.SCALAR).build();
163   }
164 }