0728f6c59b1d601e7bfab28fc23960e8f7bcdd5b
[hive.git] / ql / src / gen / vectorization / ExpressionTemplates / ColumnDivideScalarDecimal.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.DecimalColumnVector;
23 import org.apache.hadoop.hive.ql.exec.vector.VectorizedRowBatch;
24 import org.apache.hadoop.hive.ql.exec.vector.expressions.NullUtil;
25 import org.apache.hadoop.hive.ql.exec.vector.expressions.DecimalUtil;
26 import org.apache.hadoop.hive.ql.exec.vector.VectorExpressionDescriptor;
27 import org.apache.hadoop.hive.serde2.io.HiveDecimalWritable;
28 import org.apache.hadoop.hive.common.type.HiveDecimal;
29
30 /**
31  * Generated from template ColumnDivideScalarDecimal.txt, which covers binary arithmetic
32  * expressions between a column and a scalar.
33  */
34 public class <ClassName> extends VectorExpression {
35
36   private static final long serialVersionUID = 1L;
37
38   private int colNum;
39   private HiveDecimal value;
40   private int outputColumn;
41
42   public <ClassName>(int colNum, HiveDecimal value, int outputColumn) {
43     this.colNum = colNum;
44     this.value = value;
45     this.outputColumn = outputColumn;
46     this.outputType = "decimal";
47   }
48
49   public <ClassName>() {
50     this.outputType = "decimal";
51   }
52
53   @Override
54   public void evaluate(VectorizedRowBatch batch) {
55
56     if (childExpressions != null) {
57       super.evaluateChildren(batch);
58     }
59
60     DecimalColumnVector inputColVector = (DecimalColumnVector) batch.cols[colNum];
61     DecimalColumnVector outputColVector = (DecimalColumnVector) batch.cols[outputColumn];
62     int[] sel = batch.selected;
63     boolean[] inputIsNull = inputColVector.isNull;
64     boolean[] outputIsNull = outputColVector.isNull;
65     outputColVector.noNulls = inputColVector.noNulls;
66     outputColVector.isRepeating = inputColVector.isRepeating;
67     int n = batch.size;
68     HiveDecimalWritable[] vector = inputColVector.vector;
69     HiveDecimalWritable[] outputVector = outputColVector.vector;
70
71     // return immediately if batch is empty
72     if (n == 0) {
73       return;
74     }
75
76     if (inputColVector.noNulls) {
77
78      /* Initialize output vector NULL values to false. This is necessary
79       * since the decimal operation may produce a NULL result even for
80       * a non-null input vector value, and convert the output vector
81       * to have noNulls = false;
82       */
83       NullUtil.initOutputNullsToFalse(outputColVector, inputColVector.isRepeating,
84           batch.selectedInUse, sel, n);
85     }
86
87
88     if (value.compareTo(HiveDecimal.ZERO) == 0) {
89
90       // Denominator is zero, convert the batch to nulls
91       outputColVector.noNulls = false;
92       outputColVector.isRepeating = true;
93       outputIsNull[0] = true;
94     } else if (inputColVector.isRepeating) {
95       DecimalUtil.<Operator>Checked(0, vector[0], value, outputColVector);
96
97       // Even if there are no nulls, we always copy over entry 0. Simplifies code.
98       outputIsNull[0] = inputIsNull[0];
99     } else if (inputColVector.noNulls) {
100       if (batch.selectedInUse) {
101         for(int j = 0; j != n; j++) {
102           int i = sel[j];
103           DecimalUtil.<Operator>Checked(i, vector[i], value, outputColVector);
104         }
105       } else {
106         for(int i = 0; i != n; i++) {
107           DecimalUtil.<Operator>Checked(i, vector[i], value, outputColVector);
108         }
109       }
110     } else /* there are nulls */ {
111       if (batch.selectedInUse) {
112         for(int j = 0; j != n; j++) {
113           int i = sel[j];
114
115           // copy isNull entry first because operation may overwrite it
116           outputIsNull[i] = inputIsNull[i];
117           DecimalUtil.<Operator>Checked(i, vector[i], value, outputColVector);
118         }
119       } else {
120
121         // copy isNull entries first because operation may overwrite them
122         System.arraycopy(inputIsNull, 0, outputIsNull, 0, n);
123         for(int i = 0; i != n; i++) {
124           DecimalUtil.<Operator>Checked(i, vector[i], value, outputColVector);
125         }
126       }
127     }
128
129     /*
130      * Null data entries are not set to a special non-zero value because all null math operations
131      * are checked, meaning that a zero-divide always results in a null result.
132      */
133   }
134
135   @Override
136   public int getOutputColumn() {
137     return outputColumn;
138   }
139
140   @Override
141   public String vectorExpressionParameters() {
142     return "col " + colNum + ", val " + value.toString();
143   }
144
145   @Override
146   public VectorExpressionDescriptor.Descriptor getDescriptor() {
147     return (new VectorExpressionDescriptor.Builder())
148         .setMode(
149             VectorExpressionDescriptor.Mode.PROJECTION)
150         .setNumArguments(2)
151         .setArgumentTypes(
152             VectorExpressionDescriptor.ArgumentType.getType("decimal"),
153             VectorExpressionDescriptor.ArgumentType.getType("decimal"))
154         .setInputExpressionTypes(
155             VectorExpressionDescriptor.InputExpressionType.COLUMN,
156             VectorExpressionDescriptor.InputExpressionType.SCALAR).build();
157   }
158 }