001: // ============================================================================
002: // $Id: BigIntMath.java,v 1.7 2005/08/02 23:45:05 davidahall Exp $
003: // Copyright (c) 2003-2005 David A. Hall
004: // ============================================================================
005: // The contents of this file are subject to the Common Development and
006: // Distribution License (CDDL), Version 1.0 (the License); you may not use this
007: // file except in compliance with the License. You should have received a copy
008: // of the the License along with this file: if not, a copy of the License is
009: // available from Sun Microsystems, Inc.
010: //
011: // http://www.sun.com/cddl/cddl.html
012: //
013: // From time to time, the license steward (initially Sun Microsystems, Inc.) may
014: // publish revised and/or new versions of the License. You may not use,
015: // distribute, or otherwise make this file available under subsequent versions
016: // of the License.
017: //
018: // Alternatively, the contents of this file may be used under the terms of the
019: // GNU Lesser General Public License Version 2.1 or later (the "LGPL"), in which
020: // case the provisions of the LGPL are applicable instead of those above. If you
021: // wish to allow use of your version of this file only under the terms of the
022: // LGPL, and not to allow others to use your version of this file under the
023: // terms of the CDDL, indicate your decision by deleting the provisions above
024: // and replace them with the notice and other provisions required by the LGPL.
025: // If you do not delete the provisions above, a recipient may use your version
026: // of this file under the terms of either the CDDL or the LGPL.
027: //
028: // This library is distributed in the hope that it will be useful,
029: // but WITHOUT ANY WARRANTY; without even the implied warranty of
030: // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
031: // ============================================================================
032:
033: package net.sf.jga.fn.arithmetic;
034:
035: import java.math.BigInteger;
036:
037: /**
038: * Provides Arithmetic implementation for BigIntegers
039: * <p>
040: * Copyright © 2003-2005 David A. Hall
041: *
042: * @author <a href="mailto:davidahall@users.sourceforge.net">David A. Hall</a>
043: */
044:
045: class BigIntMath implements IntegerArithmetic<BigInteger> {
046:
047: static final long serialVersionUID = 8004298803104674966L;
048:
049: /**
050: * Returns the given value in the appropriate type
051: * @throws IllegalArgumentException if the value cannot be converted
052: */
053:
054: public BigInteger valueOf(Number value)
055: throws IllegalArgumentException {
056: return BigInteger.valueOf(value.longValue());
057: }
058:
059: /**
060: * Returns the value 0 of the appropriate type
061: */
062:
063: public BigInteger zero() {
064: return BigInteger.ZERO;
065: }
066:
067: /**
068: * Returns the value 1 of the appropriate type
069: */
070:
071: public BigInteger one() {
072: return BigInteger.ONE;
073: }
074:
075: /**
076: * For numeric arguments x and y, returns x + y
077: * @return the sum of the two arguments
078: */
079:
080: public BigInteger plus(BigInteger x, BigInteger y) {
081: return x.add(y);
082: }
083:
084: /**
085: * For numeric arguments x and y, returns x - y
086: * @return the difference of the two arguments
087: */
088:
089: public BigInteger minus(BigInteger x, BigInteger y) {
090: return x.subtract(y);
091: }
092:
093: /**
094: * For numeric arguments x and y, returns x * y
095: * @return the product of the two arguments
096: */
097:
098: public BigInteger multiplies(BigInteger x, BigInteger y) {
099: return x.multiply(y);
100: }
101:
102: /**
103: * For numeric arguments x and y, returns x / y
104: * @return the quotient of the two arguments
105: */
106:
107: public BigInteger divides(BigInteger x, BigInteger y) {
108: return x.divide(y);
109: }
110:
111: /**
112: * for numeric argument x, returns -x
113: * @return the negative of its argument
114: */
115:
116: public BigInteger negate(BigInteger x) {
117: return x.negate();
118: }
119:
120: /**
121: * For numeric arguments x and y, returns x % y
122: * @return the modulus of the two arguments
123: */
124:
125: public BigInteger modulus(BigInteger x, BigInteger y) {
126: return x.mod(y);
127: }
128:
129: /**
130: * For numeric arguments x and y, returns x & y
131: * @return x amp; y
132: */
133:
134: public BigInteger and(BigInteger x, BigInteger y) {
135: return x.and(y);
136: }
137:
138: /**
139: * For numeric arguments x and y, returns x | y
140: * @return x | y
141: */
142:
143: public BigInteger or(BigInteger x, BigInteger y) {
144: return x.or(y);
145: }
146:
147: /**
148: * For numeric arguments x and y, returns x ^ y
149: * @return x ^ y
150: */
151:
152: public BigInteger xor(BigInteger x, BigInteger y) {
153: return x.xor(y);
154: }
155:
156: /**
157: * For numeric argument x, returns ~x
158: * @return the one's complement of the argument
159: */
160:
161: public BigInteger not(BigInteger x) {
162: return x.not();
163: }
164:
165: /**
166: * @return x << y
167: */
168:
169: public BigInteger shiftLeft(BigInteger x, Integer y) {
170: return x.shiftLeft(y.intValue());
171: }
172:
173: /**
174: * @return x >> y
175: */
176:
177: public BigInteger signedShiftRight(BigInteger x, Integer y) {
178: return x.shiftRight(y.intValue());
179: }
180:
181: /**
182: * Optional.
183: * @return x >>> y
184: */
185:
186: public BigInteger unsignedShiftRight(BigInteger x, Integer y) {
187: String msg = "BigInteger cannot support unsigned shift";
188: throw new UnsupportedOperationException(msg);
189: }
190: }
|