diff --git a/src/main/java/org/apache/commons/math4/fraction/FractionFormat.java b/src/main/java/org/apache/commons/math4/fraction/FractionFormat.java deleted file mode 100644 index 9c8b1fef8..000000000 --- a/src/main/java/org/apache/commons/math4/fraction/FractionFormat.java +++ /dev/null @@ -1,264 +0,0 @@ -/* - * 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.commons.math4.fraction; - -import java.text.FieldPosition; -import java.text.NumberFormat; -import java.text.ParsePosition; -import java.util.Locale; - -import org.apache.commons.math4.exception.MathIllegalArgumentException; -import org.apache.commons.math4.exception.MathParseException; -import org.apache.commons.math4.exception.util.LocalizedFormats; - -/** - * Formats a Fraction number in proper format or improper format. The number - * format for each of the whole number, numerator and, denominator can be - * configured. - * - * @since 1.1 - */ -public class FractionFormat extends AbstractFormat { - - /** Serializable version identifier */ - private static final long serialVersionUID = 3008655719530972611L; - - /** - * Create an improper formatting instance with the default number format - * for the numerator and denominator. - */ - public FractionFormat() { - } - - /** - * Create an improper formatting instance with a custom number format for - * both the numerator and denominator. - * @param format the custom format for both the numerator and denominator. - */ - public FractionFormat(final NumberFormat format) { - super(format); - } - - /** - * Create an improper formatting instance with a custom number format for - * the numerator and a custom number format for the denominator. - * @param numeratorFormat the custom format for the numerator. - * @param denominatorFormat the custom format for the denominator. - */ - public FractionFormat(final NumberFormat numeratorFormat, - final NumberFormat denominatorFormat) { - super(numeratorFormat, denominatorFormat); - } - - /** - * Get the set of locales for which complex formats are available. This - * is the same set as the {@link NumberFormat} set. - * @return available complex format locales. - */ - public static Locale[] getAvailableLocales() { - return NumberFormat.getAvailableLocales(); - } - - /** - * This static method calls formatFraction() on a default instance of - * FractionFormat. - * - * @param f Fraction object to format - * @return a formatted fraction in proper form. - */ - public static String formatFraction(Fraction f) { - return getImproperInstance().format(f); - } - - /** - * Returns the default complex format for the current locale. - * @return the default complex format. - */ - public static FractionFormat getImproperInstance() { - return getImproperInstance(Locale.getDefault()); - } - - /** - * Returns the default complex format for the given locale. - * @param locale the specific locale used by the format. - * @return the complex format specific to the given locale. - */ - public static FractionFormat getImproperInstance(final Locale locale) { - return new FractionFormat(getDefaultNumberFormat(locale)); - } - - /** - * Returns the default complex format for the current locale. - * @return the default complex format. - */ - public static FractionFormat getProperInstance() { - return getProperInstance(Locale.getDefault()); - } - - /** - * Returns the default complex format for the given locale. - * @param locale the specific locale used by the format. - * @return the complex format specific to the given locale. - */ - public static FractionFormat getProperInstance(final Locale locale) { - return new ProperFractionFormat(getDefaultNumberFormat(locale)); - } - - /** - * Create a default number format. The default number format is based on - * {@link NumberFormat#getNumberInstance(java.util.Locale)} with the only - * customizing is the maximum number of fraction digits, which is set to 0. - * @return the default number format. - */ - protected static NumberFormat getDefaultNumberFormat() { - return getDefaultNumberFormat(Locale.getDefault()); - } - - /** - * Formats a {@link Fraction} object to produce a string. The fraction is - * output in improper format. - * - * @param fraction the object to format. - * @param toAppendTo where the text is to be appended - * @param pos On input: an alignment field, if desired. On output: the - * offsets of the alignment field - * @return the value passed in as toAppendTo. - */ - public StringBuffer format(final Fraction fraction, - final StringBuffer toAppendTo, final FieldPosition pos) { - - pos.setBeginIndex(0); - pos.setEndIndex(0); - - getNumeratorFormat().format(fraction.getNumerator(), toAppendTo, pos); - toAppendTo.append(" / "); - getDenominatorFormat().format(fraction.getDenominator(), toAppendTo, - pos); - - return toAppendTo; - } - - /** - * Formats an object and appends the result to a StringBuffer. obj must be either a - * {@link Fraction} object or a {@link Number} object. Any other type of - * object will result in an {@link IllegalArgumentException} being thrown. - * - * @param obj the object to format. - * @param toAppendTo where the text is to be appended - * @param pos On input: an alignment field, if desired. On output: the - * offsets of the alignment field - * @return the value passed in as toAppendTo. - * @see java.text.Format#format(java.lang.Object, java.lang.StringBuffer, java.text.FieldPosition) - * @throws FractionConversionException if the number cannot be converted to a fraction - * @throws MathIllegalArgumentException if obj is not a valid type. - */ - @Override - public StringBuffer format(final Object obj, - final StringBuffer toAppendTo, final FieldPosition pos) - throws FractionConversionException, MathIllegalArgumentException { - StringBuffer ret = null; - - if (obj instanceof Fraction) { - ret = format((Fraction) obj, toAppendTo, pos); - } else if (obj instanceof Number) { - ret = format(new Fraction(((Number) obj).doubleValue()), toAppendTo, pos); - } else { - throw new MathIllegalArgumentException(LocalizedFormats.CANNOT_FORMAT_OBJECT_TO_FRACTION); - } - - return ret; - } - - /** - * Parses a string to produce a {@link Fraction} object. - * @param source the string to parse - * @return the parsed {@link Fraction} object. - * @exception MathParseException if the beginning of the specified string - * cannot be parsed. - */ - @Override - public Fraction parse(final String source) throws MathParseException { - final ParsePosition parsePosition = new ParsePosition(0); - final Fraction result = parse(source, parsePosition); - if (parsePosition.getIndex() == 0) { - throw new MathParseException(source, parsePosition.getErrorIndex(), Fraction.class); - } - return result; - } - - /** - * Parses a string to produce a {@link Fraction} object. This method - * expects the string to be formatted as an improper fraction. - * @param source the string to parse - * @param pos input/output parsing parameter. - * @return the parsed {@link Fraction} object. - */ - @Override - public Fraction parse(final String source, final ParsePosition pos) { - final int initialIndex = pos.getIndex(); - - // parse whitespace - parseAndIgnoreWhitespace(source, pos); - - // parse numerator - final Number num = getNumeratorFormat().parse(source, pos); - if (num == null) { - // invalid integer number - // set index back to initial, error index should already be set - // character examined. - pos.setIndex(initialIndex); - return null; - } - - // parse '/' - final int startIndex = pos.getIndex(); - final char c = parseNextCharacter(source, pos); - switch (c) { - case 0 : - // no '/' - // return num as a fraction - return new Fraction(num.intValue(), 1); - case '/' : - // found '/', continue parsing denominator - break; - default : - // invalid '/' - // set index back to initial, error index should be the last - // character examined. - pos.setIndex(initialIndex); - pos.setErrorIndex(startIndex); - return null; - } - - // parse whitespace - parseAndIgnoreWhitespace(source, pos); - - // parse denominator - final Number den = getDenominatorFormat().parse(source, pos); - if (den == null) { - // invalid integer number - // set index back to initial, error index should already be set - // character examined. - pos.setIndex(initialIndex); - return null; - } - - return new Fraction(num.intValue(), den.intValue()); - } - -} diff --git a/src/main/java/org/apache/commons/math4/fraction/ProperFractionFormat.java b/src/main/java/org/apache/commons/math4/fraction/ProperFractionFormat.java deleted file mode 100644 index 1843f8af8..000000000 --- a/src/main/java/org/apache/commons/math4/fraction/ProperFractionFormat.java +++ /dev/null @@ -1,231 +0,0 @@ -/* - * 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.commons.math4.fraction; - -import java.text.FieldPosition; -import java.text.NumberFormat; -import java.text.ParsePosition; - -import org.apache.commons.math4.exception.NullArgumentException; -import org.apache.commons.math4.exception.util.LocalizedFormats; -import org.apache.commons.math4.util.FastMath; -import org.apache.commons.math4.util.MathUtils; - -/** - * Formats a Fraction number in proper format. The number format for each of - * the whole number, numerator and, denominator can be configured. - *

- * Minus signs are only allowed in the whole number part - i.e., - * "-3 1/2" is legitimate and denotes -7/2, but "-3 -1/2" is invalid and - * will result in a ParseException.

- * - * @since 1.1 - */ -public class ProperFractionFormat extends FractionFormat { - - /** Serializable version identifier */ - private static final long serialVersionUID = 760934726031766749L; - - /** The format used for the whole number. */ - private NumberFormat wholeFormat; - - /** - * Create a proper formatting instance with the default number format for - * the whole, numerator, and denominator. - */ - public ProperFractionFormat() { - this(getDefaultNumberFormat()); - } - - /** - * Create a proper formatting instance with a custom number format for the - * whole, numerator, and denominator. - * @param format the custom format for the whole, numerator, and - * denominator. - */ - public ProperFractionFormat(NumberFormat format) { - this(format, (NumberFormat)format.clone(), (NumberFormat)format.clone()); - } - - /** - * Create a proper formatting instance with a custom number format for each - * of the whole, numerator, and denominator. - * @param wholeFormat the custom format for the whole. - * @param numeratorFormat the custom format for the numerator. - * @param denominatorFormat the custom format for the denominator. - */ - public ProperFractionFormat(NumberFormat wholeFormat, - NumberFormat numeratorFormat, - NumberFormat denominatorFormat) - { - super(numeratorFormat, denominatorFormat); - setWholeFormat(wholeFormat); - } - - /** - * Formats a {@link Fraction} object to produce a string. The fraction - * is output in proper format. - * - * @param fraction the object to format. - * @param toAppendTo where the text is to be appended - * @param pos On input: an alignment field, if desired. On output: the - * offsets of the alignment field - * @return the value passed in as toAppendTo. - */ - @Override - public StringBuffer format(Fraction fraction, StringBuffer toAppendTo, - FieldPosition pos) { - - pos.setBeginIndex(0); - pos.setEndIndex(0); - - int num = fraction.getNumerator(); - int den = fraction.getDenominator(); - int whole = num / den; - num %= den; - - if (whole != 0) { - getWholeFormat().format(whole, toAppendTo, pos); - toAppendTo.append(' '); - num = FastMath.abs(num); - } - getNumeratorFormat().format(num, toAppendTo, pos); - toAppendTo.append(" / "); - getDenominatorFormat().format(den, toAppendTo, pos); - - return toAppendTo; - } - - /** - * Access the whole format. - * @return the whole format. - */ - public NumberFormat getWholeFormat() { - return wholeFormat; - } - - /** - * Parses a string to produce a {@link Fraction} object. This method - * expects the string to be formatted as a proper fraction. - *

- * Minus signs are only allowed in the whole number part - i.e., - * "-3 1/2" is legitimate and denotes -7/2, but "-3 -1/2" is invalid and - * will result in a ParseException.

- * - * @param source the string to parse - * @param pos input/ouput parsing parameter. - * @return the parsed {@link Fraction} object. - */ - @Override - public Fraction parse(String source, ParsePosition pos) { - // try to parse improper fraction - Fraction ret = super.parse(source, pos); - if (ret != null) { - return ret; - } - - int initialIndex = pos.getIndex(); - - // parse whitespace - parseAndIgnoreWhitespace(source, pos); - - // parse whole - Number whole = getWholeFormat().parse(source, pos); - if (whole == null) { - // invalid integer number - // set index back to initial, error index should already be set - // character examined. - pos.setIndex(initialIndex); - return null; - } - - // parse whitespace - parseAndIgnoreWhitespace(source, pos); - - // parse numerator - Number num = getNumeratorFormat().parse(source, pos); - if (num == null) { - // invalid integer number - // set index back to initial, error index should already be set - // character examined. - pos.setIndex(initialIndex); - return null; - } - - if (num.intValue() < 0) { - // minus signs should be leading, invalid expression - pos.setIndex(initialIndex); - return null; - } - - // parse '/' - int startIndex = pos.getIndex(); - char c = parseNextCharacter(source, pos); - switch (c) { - case 0 : - // no '/' - // return num as a fraction - return new Fraction(num.intValue(), 1); - case '/' : - // found '/', continue parsing denominator - break; - default : - // invalid '/' - // set index back to initial, error index should be the last - // character examined. - pos.setIndex(initialIndex); - pos.setErrorIndex(startIndex); - return null; - } - - // parse whitespace - parseAndIgnoreWhitespace(source, pos); - - // parse denominator - Number den = getDenominatorFormat().parse(source, pos); - if (den == null) { - // invalid integer number - // set index back to initial, error index should already be set - // character examined. - pos.setIndex(initialIndex); - return null; - } - - if (den.intValue() < 0) { - // minus signs must be leading, invalid - pos.setIndex(initialIndex); - return null; - } - - int w = whole.intValue(); - int n = num.intValue(); - int d = den.intValue(); - return new Fraction(((FastMath.abs(w) * d) + n) * MathUtils.copySign(1, w), d); - } - - /** - * Modify the whole format. - * @param format The new whole format value. - * @throws NullArgumentException if {@code format} is {@code null}. - */ - public void setWholeFormat(NumberFormat format) { - if (format == null) { - throw new NullArgumentException(LocalizedFormats.WHOLE_FORMAT); - } - this.wholeFormat = format; - } -} diff --git a/src/test/java/org/apache/commons/math4/fraction/FractionFormatTest.java b/src/test/java/org/apache/commons/math4/fraction/FractionFormatTest.java deleted file mode 100644 index fc91b6cf6..000000000 --- a/src/test/java/org/apache/commons/math4/fraction/FractionFormatTest.java +++ /dev/null @@ -1,354 +0,0 @@ -/* - * 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.commons.math4.fraction; - -import java.text.NumberFormat; -import java.util.Locale; - -import org.apache.commons.math4.exception.MathParseException; -import org.apache.commons.math4.fraction.Fraction; -import org.apache.commons.math4.fraction.FractionFormat; -import org.apache.commons.math4.fraction.ProperFractionFormat; -import org.apache.commons.math4.util.FastMath; -import org.junit.Assert; -import org.junit.Before; -import org.junit.Test; - - -public class FractionFormatTest { - - FractionFormat properFormat = null; - FractionFormat improperFormat = null; - - protected Locale getLocale() { - return Locale.getDefault(); - } - - @Before - public void setUp() { - properFormat = FractionFormat.getProperInstance(getLocale()); - improperFormat = FractionFormat.getImproperInstance(getLocale()); - } - - @Test - public void testFormat() { - Fraction c = new Fraction(1, 2); - String expected = "1 / 2"; - - String actual = properFormat.format(c); - Assert.assertEquals(expected, actual); - - actual = improperFormat.format(c); - Assert.assertEquals(expected, actual); - } - - @Test - public void testFormatNegative() { - Fraction c = new Fraction(-1, 2); - String expected = "-1 / 2"; - - String actual = properFormat.format(c); - Assert.assertEquals(expected, actual); - - actual = improperFormat.format(c); - Assert.assertEquals(expected, actual); - } - - @Test - public void testFormatZero() { - Fraction c = new Fraction(0, 1); - String expected = "0 / 1"; - - String actual = properFormat.format(c); - Assert.assertEquals(expected, actual); - - actual = improperFormat.format(c); - Assert.assertEquals(expected, actual); - } - - @Test - public void testFormatImproper() { - Fraction c = new Fraction(5, 3); - - String actual = properFormat.format(c); - Assert.assertEquals("1 2 / 3", actual); - - actual = improperFormat.format(c); - Assert.assertEquals("5 / 3", actual); - } - - @Test - public void testFormatImproperNegative() { - Fraction c = new Fraction(-5, 3); - - String actual = properFormat.format(c); - Assert.assertEquals("-1 2 / 3", actual); - - actual = improperFormat.format(c); - Assert.assertEquals("-5 / 3", actual); - } - - @Test - public void testParse() { - String source = "1 / 2"; - - try { - Fraction c = properFormat.parse(source); - Assert.assertNotNull(c); - Assert.assertEquals(1, c.getNumerator()); - Assert.assertEquals(2, c.getDenominator()); - - c = improperFormat.parse(source); - Assert.assertNotNull(c); - Assert.assertEquals(1, c.getNumerator()); - Assert.assertEquals(2, c.getDenominator()); - } catch (MathParseException ex) { - Assert.fail(ex.getMessage()); - } - } - - @Test - public void testParseInteger() { - String source = "10"; - { - Fraction c = properFormat.parse(source); - Assert.assertNotNull(c); - Assert.assertEquals(10, c.getNumerator()); - Assert.assertEquals(1, c.getDenominator()); - } - { - Fraction c = improperFormat.parse(source); - Assert.assertNotNull(c); - Assert.assertEquals(10, c.getNumerator()); - Assert.assertEquals(1, c.getDenominator()); - } - } - - @Test - public void testParseOne1() { - String source = "1 / 1"; - Fraction c = properFormat.parse(source); - Assert.assertNotNull(c); - Assert.assertEquals(1, c.getNumerator()); - Assert.assertEquals(1, c.getDenominator()); - } - - @Test - public void testParseOne2() { - String source = "10 / 10"; - Fraction c = properFormat.parse(source); - Assert.assertNotNull(c); - Assert.assertEquals(1, c.getNumerator()); - Assert.assertEquals(1, c.getDenominator()); - } - - @Test - public void testParseZero1() { - String source = "0 / 1"; - Fraction c = properFormat.parse(source); - Assert.assertNotNull(c); - Assert.assertEquals(0, c.getNumerator()); - Assert.assertEquals(1, c.getDenominator()); - } - - @Test - public void testParseZero2() { - String source = "-0 / 1"; - Fraction c = properFormat.parse(source); - Assert.assertNotNull(c); - Assert.assertEquals(0, c.getNumerator()); - Assert.assertEquals(1, c.getDenominator()); - // This test shows that the sign is not preserved. - Assert.assertEquals(Double.POSITIVE_INFINITY, 1d / c.doubleValue(), 0); - } - - @Test - public void testParseInvalid() { - String source = "a"; - String msg = "should not be able to parse '10 / a'."; - try { - properFormat.parse(source); - Assert.fail(msg); - } catch (MathParseException ex) { - // success - } - try { - improperFormat.parse(source); - Assert.fail(msg); - } catch (MathParseException ex) { - // success - } - } - - @Test - public void testParseInvalidDenominator() { - String source = "10 / a"; - String msg = "should not be able to parse '10 / a'."; - try { - properFormat.parse(source); - Assert.fail(msg); - } catch (MathParseException ex) { - // success - } - try { - improperFormat.parse(source); - Assert.fail(msg); - } catch (MathParseException ex) { - // success - } - } - - @Test - public void testParseNegative() { - - { - String source = "-1 / 2"; - Fraction c = properFormat.parse(source); - Assert.assertNotNull(c); - Assert.assertEquals(-1, c.getNumerator()); - Assert.assertEquals(2, c.getDenominator()); - - c = improperFormat.parse(source); - Assert.assertNotNull(c); - Assert.assertEquals(-1, c.getNumerator()); - Assert.assertEquals(2, c.getDenominator()); - - source = "1 / -2"; - c = properFormat.parse(source); - Assert.assertNotNull(c); - Assert.assertEquals(-1, c.getNumerator()); - Assert.assertEquals(2, c.getDenominator()); - - c = improperFormat.parse(source); - Assert.assertNotNull(c); - Assert.assertEquals(-1, c.getNumerator()); - Assert.assertEquals(2, c.getDenominator()); - } - } - - @Test - public void testParseProper() { - String source = "1 2 / 3"; - - { - Fraction c = properFormat.parse(source); - Assert.assertNotNull(c); - Assert.assertEquals(5, c.getNumerator()); - Assert.assertEquals(3, c.getDenominator()); - } - - try { - improperFormat.parse(source); - Assert.fail("invalid improper fraction."); - } catch (MathParseException ex) { - // success - } - } - - @Test - public void testParseProperNegative() { - String source = "-1 2 / 3"; - { - Fraction c = properFormat.parse(source); - Assert.assertNotNull(c); - Assert.assertEquals(-5, c.getNumerator()); - Assert.assertEquals(3, c.getDenominator()); - } - - try { - improperFormat.parse(source); - Assert.fail("invalid improper fraction."); - } catch (MathParseException ex) { - // success - } - } - - @Test - public void testParseProperInvalidMinus() { - String source = "2 -2 / 3"; - try { - properFormat.parse(source); - Assert.fail("invalid minus in improper fraction."); - } catch (MathParseException ex) { - // expected - } - source = "2 2 / -3"; - try { - properFormat.parse(source); - Assert.fail("invalid minus in improper fraction."); - } catch (MathParseException ex) { - // expected - } - } - - @Test - public void testNumeratorFormat() { - NumberFormat old = properFormat.getNumeratorFormat(); - NumberFormat nf = NumberFormat.getInstance(); - nf.setParseIntegerOnly(true); - properFormat.setNumeratorFormat(nf); - Assert.assertEquals(nf, properFormat.getNumeratorFormat()); - properFormat.setNumeratorFormat(old); - - old = improperFormat.getNumeratorFormat(); - nf = NumberFormat.getInstance(); - nf.setParseIntegerOnly(true); - improperFormat.setNumeratorFormat(nf); - Assert.assertEquals(nf, improperFormat.getNumeratorFormat()); - improperFormat.setNumeratorFormat(old); - } - - @Test - public void testDenominatorFormat() { - NumberFormat old = properFormat.getDenominatorFormat(); - NumberFormat nf = NumberFormat.getInstance(); - nf.setParseIntegerOnly(true); - properFormat.setDenominatorFormat(nf); - Assert.assertEquals(nf, properFormat.getDenominatorFormat()); - properFormat.setDenominatorFormat(old); - - old = improperFormat.getDenominatorFormat(); - nf = NumberFormat.getInstance(); - nf.setParseIntegerOnly(true); - improperFormat.setDenominatorFormat(nf); - Assert.assertEquals(nf, improperFormat.getDenominatorFormat()); - improperFormat.setDenominatorFormat(old); - } - - @Test - public void testWholeFormat() { - ProperFractionFormat format = (ProperFractionFormat)properFormat; - - NumberFormat old = format.getWholeFormat(); - NumberFormat nf = NumberFormat.getInstance(); - nf.setParseIntegerOnly(true); - format.setWholeFormat(nf); - Assert.assertEquals(nf, format.getWholeFormat()); - format.setWholeFormat(old); - } - - @Test - public void testLongFormat() { - Assert.assertEquals("10 / 1", improperFormat.format(10l)); - } - - @Test - public void testDoubleFormat() { - Assert.assertEquals("355 / 113", improperFormat.format(FastMath.PI)); - } -}