KickJava   Java API By Example, From Geeks To Geeks.

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


1 // ============================================================================
2
// $Id: ShortMath.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 package net.sf.jga.fn.arithmetic;
34
35 /**
36  * Provides Arithmetic implementation for Shorts
37  * <p>
38  * Copyright &copy; 2003-2005 David A. Hall
39  *
40  * @author <a HREF="mailto:davidahall@users.sf.net">David A. Hall</a>
41  */

42
43 class ShortMath implements IntegerArithmetic<Short JavaDoc> {
44      
45     static final long serialVersionUID = 9167946402888608933L;
46
47     static private final Short JavaDoc ZERO = new Short JavaDoc((short) 0);
48     static private final Short JavaDoc ONE = new Short JavaDoc((short) 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 Short JavaDoc valueOf(Number JavaDoc value) throws IllegalArgumentException JavaDoc {
56         return new Short JavaDoc(value.shortValue());
57     }
58
59     /**
60      * Returns the value 0 of the appropriate type
61      */

62
63     public Short JavaDoc zero() {
64         return ZERO;
65     }
66
67     /**
68      * Returns the value 1 of the appropriate type
69      */

70
71     public Short 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 Short JavaDoc plus (Short JavaDoc x, Short JavaDoc y) {
81         return new Short JavaDoc((short) (x.shortValue() + y.shortValue()));
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 Short JavaDoc minus (Short JavaDoc x, Short JavaDoc y) {
90         return new Short JavaDoc((short) (x.shortValue() - y.shortValue()));
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 Short JavaDoc multiplies (Short JavaDoc x, Short JavaDoc y){
99         return new Short JavaDoc((short) (x.shortValue() * y.shortValue()));
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 Short JavaDoc divides (Short JavaDoc x, Short JavaDoc y) {
109         return new Short JavaDoc((short) (x.shortValue() / y.shortValue()));
110     }
111      
112     /**
113      * for numeric argument x, returns -x
114      * @return the negative of its argument
115      */

116
117     public Short JavaDoc negate (Short JavaDoc x) {
118         return new Short JavaDoc((short) -x.shortValue());
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 Short JavaDoc modulus (Short JavaDoc x, Short JavaDoc y) {
127         return new Short JavaDoc((short) (x.shortValue() % y.shortValue()));
128     }
129     /**
130      * For numeric arguments x and y, returns x &amp; y
131      * @return x amp; y
132      */

133
134     public Short JavaDoc and (Short JavaDoc x, Short JavaDoc y) {
135         return new Short JavaDoc((short) (x.shortValue() & y.shortValue()));
136     }
137
138     /**
139      * For numeric arguments x and y, returns x | y
140      * @return x | y
141      */

142
143     public Short JavaDoc or (Short JavaDoc x, Short JavaDoc y) {
144         return new Short JavaDoc((short) (x.shortValue() | y.shortValue()));
145     }
146
147     /**
148      * For numeric arguments x and y, returns x ^ y
149      * @return x ^y
150      */

151
152     public Short JavaDoc xor (Short JavaDoc x, Short JavaDoc y) {
153         return new Short JavaDoc((short) (x.shortValue() ^ y.shortValue()));
154     }
155
156     /**
157      * For numeric argument x, returns ~x
158      * @return the one's complement of the argument
159      */

160
161     public Short JavaDoc not (Short JavaDoc x) {
162         return new Short JavaDoc((short) ~x.shortValue());
163     }
164
165     
166     /**
167      * @return x << y
168      */

169
170     public Short JavaDoc shiftLeft(Short JavaDoc x, Integer JavaDoc y) {
171         return new Short JavaDoc((short) (x.shortValue() << y.intValue()));
172     }
173
174     /**
175      * @return x >> y
176      */

177
178     public Short JavaDoc signedShiftRight(Short JavaDoc x, Integer JavaDoc y) {
179         return new Short JavaDoc((short) (x.shortValue() >> y.intValue()));
180     }
181
182     /**
183      * Optional.
184      * @return x >>> y
185      */

186
187     public Short JavaDoc unsignedShiftRight(Short JavaDoc x, Integer JavaDoc y) {
188         return new Short JavaDoc((short) (x.shortValue() >>> y.intValue()));
189     }
190 }
191
Popular Tags