001: // ============================================================================
002: // $Id: IntegerArithmetic.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: package net.sf.jga.fn.arithmetic;
034:
035: /**
036: * Defines arithmetic operations appropriate for Integral Numbers.
037: * <p>
038: * An implementation of IntegerArithmetic for classes (such as
039: * BigInteger) that provide the appropriate operations can simply map these
040: * methods to the methods provided by the Number. For the reference types,
041: * the implementation will need to dereference the arguments, perform the
042: * specified operation on the resulting primitives, and box up the result in
043: * a new reference type.
044: * <p>
045: * Implementations of IntegerArithmetic for user-defined Number classes must
046: * be registered with the ArithmeticFactory class. See the Arithmetic class
047: * for details.
048: * <p>
049: * Copyright © 2003-2005 David A. Hall
050: *
051: * @author <a href="mailto:davidahall@users.sourceforge.net">David A. Hall</a>
052: */
053:
054: public interface IntegerArithmetic<T extends Number> extends
055: Arithmetic<T> {
056: /**
057: * For numeric arguments x and y, returns x % y
058: * @return the modulus of the two arguments
059: */
060:
061: public T modulus(T x, T y);
062:
063: /**
064: * For numeric arguments x and y, returns x & y
065: * @return x & y
066: */
067:
068: public T and(T x, T y);
069:
070: /**
071: * For numeric arguments x and y, returns x | y
072: * @return x | y
073: */
074:
075: public T or(T x, T y);
076:
077: /**
078: * For numeric arguments x and y, returns x ^ y
079: * @return x ^ y
080: */
081:
082: public T xor(T x, T y);
083:
084: /**
085: * For numeric arguments x, returns ~x
086: * @return the one's complement of the argument
087: */
088:
089: public T not(T x);
090:
091: /**
092: * @return x << y
093: */
094:
095: public T shiftLeft(T x, Integer y);
096:
097: /**
098: * @return x >> y
099: */
100:
101: public T signedShiftRight(T x, Integer y);
102:
103: /**
104: * Optional.
105: * @return x >>> y
106: */
107:
108: public T unsignedShiftRight(T x, Integer y);
109: }
|