IntegerArithmetic


1   // ============================================================================
2   // $Id: IntegerArithmetic.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   * Defines arithmetic operations appropriate for Integral Numbers.
37   * <p>
38   * An implementation of IntegerArithmetic for classes (such as 
39   * BigInteger) that provide the appropriate operations can simply map these
40   * methods to the methods provided by the Number.  For the reference types,
41   * the implementation will need to dereference the arguments, perform the
42   * specified operation on the resulting primitives, and box up the result in
43   * a new reference type.
44   * <p>
45   * Implementations of IntegerArithmetic for user-defined Number classes must
46   * be registered with the ArithmeticFactory class.  See the Arithmetic class
47   * for details.
48   * <p>
49   * Copyright &copy; 2003-2005  David A. Hall
50   * 
51   * @author <a HREF="mailto:davidahall@users.sourceforge.net">David A. Hall</a>
52   */
53  
54  public interface IntegerArithmetic<T extends Number  >
55       extends Arithmetic<T>
56  {
57       /**
58        * For numeric arguments x and y, returns x % y
59        * @return the modulus of the two arguments
60        */
61  
62       public T modulus (T x, T y);
63  
64       /**
65        * For numeric arguments x and y, returns x & y
66        * @return x & y
67        */
68  
69       public T and (T x, T y);
70  
71      /**
72        * For numeric arguments x and y, returns x | y
73        * @return x | y
74        */
75  
76       public T or (T x, T y);
77  
78      /**
79        * For numeric arguments x and y, returns x ^ y
80        * @return x ^ y
81        */
82  
83       public T xor (T x, T y);
84  
85       /**
86        * For numeric arguments x, returns ~x
87        * @return the one's complement of the argument
88        */
89  
90       public T not (T x);
91  
92      /**
93       * @return x << y
94       */
95  
96      public T shiftLeft(T x, Integer   y);
97  
98      /**
99       * @return x >> y
100      */
101 
102     public T signedShiftRight(T x, Integer   y);
103 
104     /**
105      * Optional.
106      * @return x >>> y
107      */
108 
109     public T unsignedShiftRight(T x, Integer   y);
110 }
111
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags