BigIntegerNumber.java

/*
 * Copyright (c) 2017, SRI International
 * All rights reserved.
 * Licensed under the The BSD 3-Clause License;
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 * 
 * http://opensource.org/licenses/BSD-3-Clause
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 * 
 * Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 * 
 * Neither the name of the aic-util nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.sri.ai.util.math;

import java.math.BigDecimal;
import java.math.MathContext;

/**
 * An alternative base class to java.math.BigInteger that doesn't commit
 * to the representation being exact (i.e. BigInteger) or approximate
 * (i.e. like java.math.BigDecimal).
 * 
 * Intended for use internally by Rational.
 * 
 * @author oreilly
 *
 */
public abstract class BigIntegerNumber extends Number implements Comparable<BigIntegerNumber> {
	private static final long serialVersionUID = 1;
	
	public abstract BigIntegerNumber abs();
	public abstract BigIntegerNumber add(BigIntegerNumber val);
	public abstract int bitLength();
	public abstract BigIntegerNumber divide(BigIntegerNumber val);	
	public abstract BigIntegerNumber[] divideAndRemainder(BigIntegerNumber val);
	public abstract BigIntegerNumber gcd(BigIntegerNumber val);
	public abstract int intValueExact();
	public abstract BigIntegerNumber multiply(BigIntegerNumber val);
	public abstract BigIntegerNumber negate();
	public abstract BigIntegerNumber pow(int exponent);
	public abstract BigIntegerNumber remainder(BigIntegerNumber val);
	public abstract int signum();
	public abstract BigDecimal log(MathContext logMathContext);
	public abstract BigIntegerNumber subtract(BigIntegerNumber val);
	public abstract String toString(int radix);
}