Apache
/
poi
mirror of https://github.com/apache/poi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

add dollarfr function 

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1897759 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
PJ Fanning 2022-02-04 10:32:00 +00:00
parent 865913b5c5
commit fb5b777528
5 changed files with 235 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
poi/src/main/java/org/apache/poi/ss/formula/atp/AnalysisToolPak.java
View File

@ -103,7 +103,7 @@ public final class AnalysisToolPak implements UDFFinder {
r(m, "DELTA", Delta.instance);
r(m, "DISC", null);
r(m, "DOLLARDE", DollarDe.instance);
r(m, "DOLLARFR", null);
r(m, "DOLLARFR", DollarFr.instance);
r(m, "DURATION", null);
r(m, "EDATE", EDate.instance);
r(m, "EFFECT", null);

33
poi/src/main/java/org/apache/poi/ss/formula/functions/DollarDe.java
View File

@ -26,12 +26,11 @@ import org.apache.poi.ss.formula.eval.ValueEval;
import java.math.BigDecimal;
import java.math.MathContext;
import java.text.NumberFormat;
/**
* Implementation for Excel DOLLARDE() function.
* <p>
* <https://support.microsoft.com/en-us/office/dollarde-function-db85aab0-1677-428a-9dfd-a38476693427
* https://support.microsoft.com/en-us/office/dollarde-function-db85aab0-1677-428a-9dfd-a38476693427
*/
public final class DollarDe extends Fixed2ArgFunction implements FreeRefFunction {
@ -54,26 +53,30 @@ public final class DollarDe extends Fixed2ArgFunction implements FreeRefFunction
} else if (fraction == 0) {
return ErrorEval.DIV_ZERO;
}
int fractionLength = String.valueOf(fraction).length();
boolean negative = false;
long valueLong = number1.longValue();
if (valueLong < 0) {
negative = true;
valueLong = -valueLong;
number1 = -number1;
}
double valueFractional = number1 - valueLong;
if (valueFractional == 0.0) {
return new NumberEval(valueLong);
}
int iterations = 0;
final int maxIterations = 100;
while (valueFractional < fraction && iterations < maxIterations) {
valueFractional = valueFractional * 10;
iterations++;
}
if (iterations == maxIterations && valueFractional < fraction) {
return new NumberEval(valueLong);
}
BigDecimal calc = new BigDecimal((long)valueFractional)
.divide(BigDecimal.valueOf(10), MathContext.DECIMAL128)
.divide(BigDecimal.valueOf(fraction), MathContext.DECIMAL128);
return new NumberEval(calc.add(BigDecimal.valueOf(valueLong)).doubleValue());
BigDecimal inflated = BigDecimal.valueOf(valueFractional).multiply(BigDecimal.valueOf(Math.pow(10, fractionLength)));
BigDecimal calc = inflated.divide(BigDecimal.valueOf(fraction), MathContext.DECIMAL128);
BigDecimal result = calc.add(BigDecimal.valueOf(valueLong));
if (negative) {
result = result.multiply(BigDecimal.valueOf(-1));
}
return new NumberEval(result.doubleValue());
} catch (EvaluationException e) {
return e.getErrorEval();
}

101
poi/src/main/java/org/apache/poi/ss/formula/functions/DollarFr.java Normal file
View File

@ -0,0 +1,101 @@
/* ====================================================================
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.functions;
import org.apache.poi.ss.formula.OperationEvaluationContext;
import org.apache.poi.ss.formula.eval.ErrorEval;
import org.apache.poi.ss.formula.eval.EvaluationException;
import org.apache.poi.ss.formula.eval.NumberEval;
import org.apache.poi.ss.formula.eval.OperandResolver;
import org.apache.poi.ss.formula.eval.ValueEval;
import java.math.BigDecimal;
import java.math.MathContext;
import java.text.NumberFormat;
import java.util.Locale;
/**
* Implementation for Excel DOLLARFR() function.
* <p>
* https://support.microsoft.com/en-us/office/dollarfr-function-0835d163-3023-4a33-9824-3042c5d4f495
*/
public final class DollarFr extends Fixed2ArgFunction implements FreeRefFunction {
public static final FreeRefFunction instance = new DollarFr();
@Override
public ValueEval evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg1, ValueEval arg2) {
try {
Double number1 = evaluateValue(arg1, srcRowIndex, srcColumnIndex);
if (number1 == null) {
return ErrorEval.VALUE_INVALID;
}
Double number2 = evaluateValue(arg2, srcRowIndex, srcColumnIndex);
if (number2 == null) {
return ErrorEval.VALUE_INVALID;
}
int fraction = number2.intValue();
if (fraction < 0) {
return ErrorEval.NUM_ERROR;
} else if (fraction == 0) {
return ErrorEval.DIV_ZERO;
}
int fractionLength = String.valueOf(fraction).length();
boolean negative = false;
long valueLong = number1.longValue();
if (valueLong < 0) {
negative = true;
valueLong = -valueLong;
number1 = -number1;
}
double valueFractional = number1 - valueLong;
if (valueFractional == 0.0) {
return new NumberEval(valueLong);
}
BigDecimal calc = BigDecimal.valueOf(valueFractional).multiply(BigDecimal.valueOf(fraction))
.divide(BigDecimal.valueOf(Math.pow(10, fractionLength)), MathContext.DECIMAL128);
BigDecimal result = calc.add(BigDecimal.valueOf(valueLong));
if (negative) {
result = result.multiply(BigDecimal.valueOf(-1));
}
return new NumberEval(result.doubleValue());
} catch (EvaluationException e) {
return e.getErrorEval();
}
}
@Override
public ValueEval evaluate(ValueEval[] args, OperationEvaluationContext ec) {
if (args.length == 2) {
return evaluate(ec.getRowIndex(), ec.getColumnIndex(), args[0], args[1]);
}
return ErrorEval.VALUE_INVALID;
}
private static Double evaluateValue(ValueEval arg, int srcRowIndex, int srcColumnIndex) throws EvaluationException {
ValueEval veText = OperandResolver.getSingleValue(arg, srcRowIndex, srcColumnIndex);
String strText1 = OperandResolver.coerceValueToString(veText);
return OperandResolver.parseDouble(strText1);
}
}

13
poi/src/test/java/org/apache/poi/ss/formula/functions/TestDollarDe.java
View File

@ -68,10 +68,15 @@ final class TestDollarDe {
HSSFRow row = sheet.createRow(0);
HSSFFormulaEvaluator fe = new HSSFFormulaEvaluator(wb);
HSSFCell cell = row.createCell(0);
assertDouble(fe, cell, "DOLLARDE(1.02,16)", 1.125, 0.00000000000001);
assertDouble(fe, cell, "DOLLARDE(1.02,16.9)", 1.125, 0.00000000000001);
assertDouble(fe, cell, "DOLLARDE(1.1,32)", 1.3125, 0.00000000000001);
assertDouble(fe, cell, "DOLLARDE(1.1,32.1)", 1.3125, 0.00000000000001);
double tolerance = 0.000000000000001;
assertDouble(fe, cell, "DOLLARDE(1.02,16)", 1.125, tolerance);
assertDouble(fe, cell, "DOLLARDE(1.02,16.9)", 1.125, tolerance);
assertDouble(fe, cell, "DOLLARDE(1.32,16)", 3.0, tolerance);
assertDouble(fe, cell, "DOLLARDE(-1.02,16)", -1.125, tolerance);
assertDouble(fe, cell, "DOLLARDE(1.1,32)", 1.3125, tolerance);
assertDouble(fe, cell, "DOLLARDE(1.1,32.1)", 1.3125, tolerance);
assertDouble(fe, cell, "DOLLARDE(1.0,32)", 1.0, tolerance);
assertDouble(fe, cell, "DOLLARDE(1.000001,32)", 1.000003125, tolerance);
}
}

106
poi/src/test/java/org/apache/poi/ss/formula/functions/TestDollarFr.java Normal file
View File

@ -0,0 +1,106 @@
/* ====================================================================
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.functions;
import org.apache.poi.hssf.usermodel.HSSFCell;
import org.apache.poi.hssf.usermodel.HSSFFormulaEvaluator;
import org.apache.poi.hssf.usermodel.HSSFRow;
import org.apache.poi.hssf.usermodel.HSSFSheet;
import org.apache.poi.hssf.usermodel.HSSFWorkbook;
import org.apache.poi.ss.formula.OperationEvaluationContext;
import org.apache.poi.ss.formula.eval.ErrorEval;
import org.apache.poi.ss.formula.eval.NumberEval;
import org.apache.poi.ss.formula.eval.StringEval;
import org.apache.poi.ss.formula.eval.ValueEval;
import org.junit.jupiter.api.Test;
import java.io.IOException;
import static org.apache.poi.ss.util.Utils.assertDouble;
import static org.junit.jupiter.api.Assertions.assertEquals;
/**
* Tests for {@link DollarFr}
*/
final class TestDollarFr {
private static final OperationEvaluationContext ec = new OperationEvaluationContext(null, null, 0, 0, 0, null);
@Test
void testInvalid() {
confirmInvalidError("A1","B2");
}
@Test
void testNumError() {
confirmNumError("22.5","-40");
}
@Test
void testDiv0() {
confirmDiv0("22.5","0");
confirmDiv0("22.5","0.9");
confirmDiv0("22.5","-0.9");
}
//https://support.microsoft.com/en-us/office/dollarfr-function-0835d163-3023-4a33-9824-3042c5d4f495
@Test
void testMicrosoftExample1() throws IOException {
try (HSSFWorkbook wb = new HSSFWorkbook()) {
HSSFSheet sheet = wb.createSheet();
HSSFRow row = sheet.createRow(0);
HSSFFormulaEvaluator fe = new HSSFFormulaEvaluator(wb);
HSSFCell cell = row.createCell(0);
double tolerance = 0.000000000000001;
assertDouble(fe, cell, "DOLLARFR(1.125,16)", 1.02, tolerance);
assertDouble(fe, cell, "DOLLARFR(-1.125,16)", -1.02, tolerance);
assertDouble(fe, cell, "DOLLARFR(1.000125,16)", 1.00002, tolerance);
assertDouble(fe, cell, "DOLLARFR(1.125,32)", 1.04, tolerance);
}
}
private static ValueEval invokeValue(String number1, String number2) {
ValueEval[] args = new ValueEval[] { new StringEval(number1), new StringEval(number2) };
return DollarDe.instance.evaluate(args, ec);
}
private static void confirmValue(String number1, String number2, double expected) {
ValueEval result = invokeValue(number1, number2);
assertEquals(NumberEval.class, result.getClass());
assertEquals(expected, ((NumberEval) result).getNumberValue(), 0.00000000000001);
}
private static void confirmInvalidError(String number1, String number2) {
ValueEval result = invokeValue(number1, number2);
assertEquals(ErrorEval.class, result.getClass());
assertEquals(ErrorEval.VALUE_INVALID, result);
}
private static void confirmNumError(String number1, String number2) {
ValueEval result = invokeValue(number1, number2);
assertEquals(ErrorEval.class, result.getClass());
assertEquals(ErrorEval.NUM_ERROR, result);
}
private static void confirmDiv0(String number1, String number2) {
ValueEval result = invokeValue(number1, number2);
assertEquals(ErrorEval.class, result.getClass());
assertEquals(ErrorEval.DIV_ZERO, result);
}
}