4fcbdc0317f75d4cc5ac6485006530398ba76234
[hive.git] / ql / src / gen / vectorization / ExpressionTemplates / ScalarArithmeticColumn.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.VectorExpressionDescriptor;
23
24 /*
25  * Because of the templatized nature of the code, either or both
26  * of these ColumnVector imports may be needed. Listing both of them
27  * rather than using ....vectorization.*;
28  */
29 import org.apache.hadoop.hive.ql.exec.vector.DoubleColumnVector;
30 import org.apache.hadoop.hive.ql.exec.vector.LongColumnVector;
31 import org.apache.hadoop.hive.ql.exec.vector.VectorizedRowBatch;
32 import org.apache.hadoop.hive.ql.exec.vector.expressions.NullUtil;
33
34 /**
35  * Generated from template ScalarArithmeticColumn.txt.
36  * Implements a vectorized arithmetic operator with a scalar on the left and a
37  * column vector on the right. The result is output to an output column vector.
38  */
39 public class <ClassName> extends VectorExpression {
40
41   private static final long serialVersionUID = 1L;
42
43   private int colNum;
44   private <OperandType1> value;
45   private int outputColumn;
46
47   public <ClassName>(<OperandType1> value, int colNum, int outputColumn) {
48     this.colNum = colNum;
49     this.value = value;
50     this.outputColumn = outputColumn;
51   }
52
53   public <ClassName>() {
54   }
55
56   @Override
57   /**
58    * Method to evaluate scalar-column operation in vectorized fashion.
59    *
60    * @batch a package of rows with each column stored in a vector
61    */
62   public void evaluate(VectorizedRowBatch batch) {
63
64     if (childExpressions != null) {
65       super.evaluateChildren(batch);
66     }
67
68     <InputColumnVectorType> inputColVector = (<InputColumnVectorType>) batch.cols[colNum];
69     <OutputColumnVectorType> outputColVector = (<OutputColumnVectorType>) batch.cols[outputColumn];
70     int[] sel = batch.selected;
71     boolean[] inputIsNull = inputColVector.isNull;
72     boolean[] outputIsNull = outputColVector.isNull;
73     outputColVector.noNulls = inputColVector.noNulls;
74     outputColVector.isRepeating = inputColVector.isRepeating;
75     int n = batch.size;
76     <OperandType2>[] vector = inputColVector.vector;
77     <ReturnType>[] outputVector = outputColVector.vector;
78     
79     // return immediately if batch is empty
80     if (n == 0) {
81       return;
82     }
83
84     if (inputColVector.isRepeating) {
85       outputVector[0] = value <OperatorSymbol> vector[0];
86       
87       // Even if there are no nulls, we always copy over entry 0. Simplifies code.
88       outputIsNull[0] = inputIsNull[0]; 
89     } else if (inputColVector.noNulls) {
90       if (batch.selectedInUse) {
91         for(int j = 0; j != n; j++) {
92           int i = sel[j];
93           outputVector[i] = value <OperatorSymbol> vector[i];
94         }
95       } else {
96         for(int i = 0; i != n; i++) {
97           outputVector[i] = value <OperatorSymbol> vector[i];
98         }
99       }
100     } else {                         /* there are nulls */ 
101       if (batch.selectedInUse) {
102         for(int j = 0; j != n; j++) {
103           int i = sel[j];
104           outputVector[i] = value <OperatorSymbol> vector[i];
105           outputIsNull[i] = inputIsNull[i];
106         }
107       } else {
108         for(int i = 0; i != n; i++) {
109           outputVector[i] = value <OperatorSymbol> vector[i];
110         }
111         System.arraycopy(inputIsNull, 0, outputIsNull, 0, n);
112       }
113     }
114     
115     NullUtil.setNullOutputEntriesColScalar(outputColVector, batch.selectedInUse, sel, n);
116   }
117
118   @Override
119   public int getOutputColumn() {
120     return outputColumn;
121   }
122   
123   @Override
124   public String getOutputType() {
125     return "<ReturnType>";
126   }
127   
128   public int getColNum() {
129     return colNum;
130   }
131
132   public void setColNum(int colNum) {
133     this.colNum = colNum;
134   }
135
136   public <OperandType1> getValue() {
137     return value;
138   }
139
140   public void setValue(<OperandType1> value) {
141     this.value = value;
142   }
143
144   public void setOutputColumn(int outputColumn) {
145     this.outputColumn = outputColumn;
146   }
147
148   @Override
149   public VectorExpressionDescriptor.Descriptor getDescriptor() {
150     return (new VectorExpressionDescriptor.Builder())
151         .setMode(
152             VectorExpressionDescriptor.Mode.PROJECTION)
153         .setNumArguments(2)
154         .setArgumentTypes(
155             VectorExpressionDescriptor.ArgumentType.getType("<OperandType1>"),
156             VectorExpressionDescriptor.ArgumentType.getType("<OperandType2>"))
157         .setInputExpressionTypes(
158             VectorExpressionDescriptor.InputExpressionType.SCALAR,
159             VectorExpressionDescriptor.InputExpressionType.COLUMN).build();
160   }
161 }