/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.hadoop.hive.ql.exec.vector.expressions;

import org.apache.hadoop.hive.ql.exec.vector.VectorExpressionDescriptor;

public class PosModLongToLong extends MathFuncLongToLong
    implements ISetLongArg {
  private static final long serialVersionUID = 1L;
  private long divisor;

  public PosModLongToLong(int inputCol, long scalarVal, int outputCol) {
    super(inputCol, outputCol);
    this.divisor = scalarVal;
  }

  public PosModLongToLong() {
    super();
  }

  @Override
  protected long func(long v) {

    // return positive modulo
    return ((v % divisor) + divisor) % divisor;
  }

  @Override
  public void setArg(long arg) {
    this.divisor = arg;
  }

  public void setDivisor(long v) {
    this.divisor = v;
  }

  public long getDivisor() {
    return divisor;
  }

  @Override
  public String vectorExpressionParameters() {
    return "col " + colNum + ", divisor " + divisor;
  }

  @Override
  public VectorExpressionDescriptor.Descriptor getDescriptor() {
    return (new VectorExpressionDescriptor.Builder())
        .setMode(
            VectorExpressionDescriptor.Mode.PROJECTION)
        .setNumArguments(2)
        .setArgumentTypes(
            VectorExpressionDescriptor.ArgumentType.INT_FAMILY,
            VectorExpressionDescriptor.ArgumentType.INT_FAMILY)
        .setInputExpressionTypes(
            VectorExpressionDescriptor.InputExpressionType.COLUMN,
            VectorExpressionDescriptor.InputExpressionType.SCALAR).build();
  }
}
