TwoOperandNumericOperation.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.poi.ss.formula.eval;

import org.apache.poi.ss.formula.functions.ArrayFunction;
import org.apache.poi.ss.formula.functions.Fixed2ArgFunction;
import org.apache.poi.ss.formula.functions.Function;
import org.apache.poi.ss.util.ExcelArithmetic;

public abstract class TwoOperandNumericOperation extends Fixed2ArgFunction implements ArrayFunction {

    protected final double singleOperandEvaluate(ValueEval arg, int srcCellRow, int srcCellCol) throws EvaluationException {
        ValueEval ve = OperandResolver.getSingleValue(arg, srcCellRow, srcCellCol);
        return OperandResolver.coerceValueToDouble(ve);
    }

    @Override
    public ValueEval evaluateArray(ValueEval[] args, int srcRowIndex, int srcColumnIndex) {
        if (args.length != 2) {
            return ErrorEval.VALUE_INVALID;
        }
        //return new ArrayEval().evaluate(srcRowIndex, srcColumnIndex, args[0], args[1]);

        return evaluateTwoArrayArgs(args[0], args[1], srcRowIndex, srcColumnIndex,
                (vA, vB) -> {
                    try {
                        double d0 = OperandResolver.coerceValueToDouble(vA);
                        double d1 = OperandResolver.coerceValueToDouble(vB);
                        return toValueEval(evaluate(d0, d1));
                    } catch (EvaluationException e){
                        return e.getErrorEval();
                    }
                });

    }

    @Override
    public ValueEval evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0, ValueEval arg1) {
        try {
            double d0 = singleOperandEvaluate(arg0, srcRowIndex, srcColumnIndex);
            double d1 = singleOperandEvaluate(arg1, srcRowIndex, srcColumnIndex);
            return toValueEval(evaluate(d0, d1));
        } catch (EvaluationException e) {
            return e.getErrorEval();
        }
    }

    private ValueEval toValueEval(double result) {
        if (result == 0.0) { // this '==' matches +0.0 and -0.0
            // Excel converts -0.0 to +0.0 for '*', '/', '%', '+' and '^'
            if (!(this instanceof SubtractEvalClass)) {
                return NumberEval.ZERO;
            }
        } else if (Math.abs(result) < Double.MIN_NORMAL) {
            // Excel does not support subnormal numbers: underflow gives 0
            return NumberEval.ZERO;
        }
        if (Double.isNaN(result) || Double.isInfinite(result)) {
            return ErrorEval.NUM_ERROR;
        }
        return new NumberEval(result);
    }

    protected abstract double evaluate(double d0, double d1) throws EvaluationException;

    public static final Function AddEval = new TwoOperandNumericOperation() {
        @Override
        protected double evaluate(double d0, double d1) {
            return ExcelArithmetic.approxAdd(d0, d1);
        }
    };
    public static final Function DivideEval = new TwoOperandNumericOperation() {
        @Override
        protected double evaluate(double d0, double d1) throws EvaluationException {
            if (d1 == 0.0) {
                throw new EvaluationException(ErrorEval.DIV_ZERO);
            }
            return d0 / d1;
        }
    };
    public static final Function MultiplyEval = new TwoOperandNumericOperation() {
        @Override
        protected double evaluate(double d0, double d1) {
            return d0 * d1;
        }
    };
    public static final Function PowerEval = new TwoOperandNumericOperation() {
        @Override
        protected double evaluate(double d0, double d1) throws EvaluationException {
            if (d0 == 0.0) {
                // Excel: 0^0 is #NUM! and 0^negative is #DIV/0! (Math.pow gives 1 and Infinity)
                if (d1 == 0.0) {
                    throw new EvaluationException(ErrorEval.NUM_ERROR);
                }
                if (d1 < 0.0) {
                    throw new EvaluationException(ErrorEval.DIV_ZERO);
                }
            }
            // a negative base with a non-integer exponent is NaN, hence #NUM!, as in Excel (and POWER)
            return Math.pow(d0, d1);
        }
    };
    private static final class SubtractEvalClass extends TwoOperandNumericOperation {
        public SubtractEvalClass() {
            //
        }
        @Override
        protected double evaluate(double d0, double d1) {
            return ExcelArithmetic.approxSub(d0, d1);
        }
    }
    public static final Function SubtractEval = new SubtractEvalClass();
}