DivDoubleFunction.java

/*
 * 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.solr.analytics.util.valuesource;

import java.io.IOException;

import org.apache.lucene.queries.function.FunctionValues;
import org.apache.lucene.queries.function.ValueSource;
import org.apache.solr.analytics.util.AnalyticsParams;

/**
 * <code>DivDoubleFunction</code> returns the quotient of 'a' and 'b'.
 */
public class DivDoubleFunction extends DualDoubleFunction {
  public final static String NAME = AnalyticsParams.DIVIDE;

  /**
    * @param   a  the numerator.
    * @param   b  the denominator.
    */
  public DivDoubleFunction(ValueSource a, ValueSource b) {
    super(a, b);
  }

  protected String name() {
    return NAME;
  }

  @Override
  protected double func(int doc, FunctionValues aVals, FunctionValues bVals) throws IOException {
    return aVals.doubleVal(doc)/bVals.doubleVal(doc);
  }

}