KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > sf > jga > fn > arithmetic > IntegerMath


1 // ============================================================================
2 // $Id: IntegerMath.java,v 1.7 2005/08/02 23:45:06 davidahall Exp $
3 // Copyright (c) 2003-2005 David A. Hall
4 // ============================================================================
5 // The contents of this file are subject to the Common Development and
6 // Distribution License (CDDL), Version 1.0 (the License); you may not use this
7 // file except in compliance with the License. You should have received a copy
8 // of the the License along with this file: if not, a copy of the License is
9 // available from Sun Microsystems, Inc.
10 //
11 // http://www.sun.com/cddl/cddl.html
12 //
13 // From time to time, the license steward (initially Sun Microsystems, Inc.) may
14 // publish revised and/or new versions of the License. You may not use,
15 // distribute, or otherwise make this file available under subsequent versions
16 // of the License.
17 //
18 // Alternatively, the contents of this file may be used under the terms of the
19 // GNU Lesser General Public License Version 2.1 or later (the "LGPL"), in which
20 // case the provisions of the LGPL are applicable instead of those above. If you
21 // wish to allow use of your version of this file only under the terms of the
22 // LGPL, and not to allow others to use your version of this file under the
23 // terms of the CDDL, indicate your decision by deleting the provisions above
24 // and replace them with the notice and other provisions required by the LGPL.
25 // If you do not delete the provisions above, a recipient may use your version
26 // of this file under the terms of either the CDDL or the LGPL.
27 //
28 // This library is distributed in the hope that it will be useful,
29 // but WITHOUT ANY WARRANTY; without even the implied warranty of
30 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
31 // ============================================================================
32
33 /**
34  * Provides Arithmetic implementation for Integers
35  * <p>
36  * Copyright &copy; 2003-2005 David A. Hall
37  *
38  * @author <a HREF="mailto:dave@dolphin.hallsquared.org">David A. Hall</a>
39  */
40
41 package net.sf.jga.fn.arithmetic;
42
43 class IntegerMath implements IntegerArithmetic<Integer JavaDoc> {
44      
45     static final long serialVersionUID = 4213102951085209726L;
46
47     static private final Integer JavaDoc ZERO = new Integer JavaDoc(0);
48     static private final Integer JavaDoc ONE = new Integer JavaDoc(1);
49     
50     /**
51      * Returns the given value in the appropriate type
52      * @throws IllegalArgumentException if the value cannot be converted
53      */
54
55     public Integer JavaDoc valueOf(Number JavaDoc value) throws IllegalArgumentException JavaDoc {
56         return new Integer JavaDoc(value.intValue());
57     }
58
59     /**
60      * Returns the value 0 of the appropriate type
61      */
62
63     public Integer JavaDoc zero() {
64         return ZERO;
65     }
66
67     /**
68      * Returns the value 1 of the appropriate type
69      */
70
71     public Integer JavaDoc one() {
72         return ONE;
73     }
74
75    /**
76     * For numeric arguments x and y, returns x + y
77     * @return the sum of the two arguments
78     */
79
80     public Integer JavaDoc plus (Integer JavaDoc x, Integer JavaDoc y) {
81         return new Integer JavaDoc(x.intValue() + y.intValue());
82     }
83
84    /**
85     * For numeric arguments x and y, returns x - y
86     * @return the difference of the two arguments
87     */
88      
89     public Integer JavaDoc minus (Integer JavaDoc x, Integer JavaDoc y) {
90         return new Integer JavaDoc(x.intValue() - y.intValue());
91     }
92      
93    /**
94     * For numeric arguments x and y, returns x * y
95     * @return the product of the two arguments
96     */
97
98     public Integer JavaDoc multiplies (Integer JavaDoc x, Integer JavaDoc y){
99         return new Integer JavaDoc(x.intValue() * y.intValue());
100     }
101          
102
103     /**
104      * For numeric arguments x and y, returns x / y
105      * @return the quotient of the two arguments
106      */
107
108     public Integer JavaDoc divides (Integer JavaDoc x, Integer JavaDoc y) {
109         return new Integer JavaDoc(x.intValue() / y.intValue());
110     }
111
112     /**
113      * for numeric argument x, returns -x
114      * @return the negative of its argument
115      */
116
117     public Integer JavaDoc negate (Integer JavaDoc x) {
118         return new Integer JavaDoc(-x.intValue());
119     }
120     
121    /**
122     * For numeric arguments x and y, returns x % y
123     * @return the modulus of the two arguments
124     */
125      
126     public Integer JavaDoc modulus (Integer JavaDoc x, Integer JavaDoc y) {
127         return new Integer JavaDoc(x.intValue() % y.intValue());
128     }
129
130     /**
131      * For numeric arguments x and y, returns x &amp; y
132      * @return x amp; y
133      */
134
135     public Integer JavaDoc and (Integer JavaDoc x, Integer JavaDoc y) {
136         return new Integer JavaDoc(x.intValue() & y.intValue());
137     }
138
139     /**
140      * For numeric arguments x and y, returns x | y
141      * @return x | y
142      */
143
144     public Integer JavaDoc or (Integer JavaDoc x, Integer JavaDoc y) {
145         return new Integer JavaDoc(x.intValue() | y.intValue());
146     }
147
148     /**
149      * For numeric arguments x and y, returns x ^ y
150      * @return x ^ y
151      */
152
153     public Integer JavaDoc xor (Integer JavaDoc x, Integer JavaDoc y) {
154         return new Integer JavaDoc(x.intValue() ^ y.intValue());
155     }
156
157     /**
158      * For numeric argument x, returns ~x
159      * @return the one's complement of the argument
160      */
161
162     public Integer JavaDoc not (Integer JavaDoc x) {
163         return new Integer JavaDoc(~x.intValue());
164     }
165
166     /**
167      * @return x << y
168      */
169
170     public Integer JavaDoc shiftLeft(Integer JavaDoc x, Integer JavaDoc y) {
171         return new Integer JavaDoc(x.intValue() << y.intValue());
172     }
173
174     /**
175      * @return x >> y
176      */
177
178     public Integer JavaDoc signedShiftRight(Integer JavaDoc x, Integer JavaDoc y) {
179         return new Integer JavaDoc(x.intValue() >> y.intValue());
180     }
181
182     /**
183      * Optional.
184      * @return x >>> y
185      */
186
187     public Integer JavaDoc unsignedShiftRight(Integer JavaDoc x, Integer JavaDoc y) {
188         return new Integer JavaDoc(x.intValue() >>> y.intValue());
189     }
190 }
191
Popular Tags