001: // ============================================================================
002: // $Id: IntegerMath.java,v 1.7 2005/08/02 23:45:06 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: /**
034: * Provides Arithmetic implementation for Integers
035: * <p>
036: * Copyright © 2003-2005 David A. Hall
037: *
038: * @author <a href="mailto:dave@dolphin.hallsquared.org">David A. Hall</a>
039: */package net.sf.jga.fn.arithmetic;
040:
041: class IntegerMath implements IntegerArithmetic<Integer> {
042:
043: static final long serialVersionUID = 4213102951085209726L;
044:
045: static private final Integer ZERO = new Integer(0);
046: static private final Integer ONE = new Integer(1);
047:
048: /**
049: * Returns the given value in the appropriate type
050: * @throws IllegalArgumentException if the value cannot be converted
051: */
052:
053: public Integer valueOf(Number value)
054: throws IllegalArgumentException {
055: return new Integer(value.intValue());
056: }
057:
058: /**
059: * Returns the value 0 of the appropriate type
060: */
061:
062: public Integer zero() {
063: return ZERO;
064: }
065:
066: /**
067: * Returns the value 1 of the appropriate type
068: */
069:
070: public Integer one() {
071: return ONE;
072: }
073:
074: /**
075: * For numeric arguments x and y, returns x + y
076: * @return the sum of the two arguments
077: */
078:
079: public Integer plus(Integer x, Integer y) {
080: return new Integer(x.intValue() + y.intValue());
081: }
082:
083: /**
084: * For numeric arguments x and y, returns x - y
085: * @return the difference of the two arguments
086: */
087:
088: public Integer minus(Integer x, Integer y) {
089: return new Integer(x.intValue() - y.intValue());
090: }
091:
092: /**
093: * For numeric arguments x and y, returns x * y
094: * @return the product of the two arguments
095: */
096:
097: public Integer multiplies(Integer x, Integer y) {
098: return new Integer(x.intValue() * y.intValue());
099: }
100:
101: /**
102: * For numeric arguments x and y, returns x / y
103: * @return the quotient of the two arguments
104: */
105:
106: public Integer divides(Integer x, Integer y) {
107: return new Integer(x.intValue() / y.intValue());
108: }
109:
110: /**
111: * for numeric argument x, returns -x
112: * @return the negative of its argument
113: */
114:
115: public Integer negate(Integer x) {
116: return new Integer(-x.intValue());
117: }
118:
119: /**
120: * For numeric arguments x and y, returns x % y
121: * @return the modulus of the two arguments
122: */
123:
124: public Integer modulus(Integer x, Integer y) {
125: return new Integer(x.intValue() % y.intValue());
126: }
127:
128: /**
129: * For numeric arguments x and y, returns x & y
130: * @return x amp; y
131: */
132:
133: public Integer and(Integer x, Integer y) {
134: return new Integer(x.intValue() & y.intValue());
135: }
136:
137: /**
138: * For numeric arguments x and y, returns x | y
139: * @return x | y
140: */
141:
142: public Integer or(Integer x, Integer y) {
143: return new Integer(x.intValue() | y.intValue());
144: }
145:
146: /**
147: * For numeric arguments x and y, returns x ^ y
148: * @return x ^ y
149: */
150:
151: public Integer xor(Integer x, Integer y) {
152: return new Integer(x.intValue() ^ y.intValue());
153: }
154:
155: /**
156: * For numeric argument x, returns ~x
157: * @return the one's complement of the argument
158: */
159:
160: public Integer not(Integer x) {
161: return new Integer(~x.intValue());
162: }
163:
164: /**
165: * @return x << y
166: */
167:
168: public Integer shiftLeft(Integer x, Integer y) {
169: return new Integer(x.intValue() << y.intValue());
170: }
171:
172: /**
173: * @return x >> y
174: */
175:
176: public Integer signedShiftRight(Integer x, Integer y) {
177: return new Integer(x.intValue() >> y.intValue());
178: }
179:
180: /**
181: * Optional.
182: * @return x >>> y
183: */
184:
185: public Integer unsignedShiftRight(Integer x, Integer y) {
186: return new Integer(x.intValue() >>> y.intValue());
187: }
188: }
|