truffle: graal/com.oracle.graal.word/src/com/oracle/graal/word/Signed.java annotate

annotate graal/com.oracle.graal.word/src/com/oracle/graal/word/Signed.java @ 12355:cefad50507d8

Merge with hs25-b53

author	Gilles Duboscq <duboscq@ssw.jku.at>
date	Fri, 11 Oct 2013 10:38:03 +0200
parents	47467b2c3fc5
children	103a0003db01

rev	line source
7300 2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	1 /*
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	2 * Copyright (c) 2012, 2012, Oracle and/or its affiliates. All rights reserved.
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	4 *
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	5 * This code is free software; you can redistribute it and/or modify it
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	6 * under the terms of the GNU General Public License version 2 only, as
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	7 * published by the Free Software Foundation.
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	8 *
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	9 * This code is distributed in the hope that it will be useful, but WITHOUT
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	12 * version 2 for more details (a copy is included in the LICENSE file that
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	13 * accompanied this code).
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	14 *
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	15 * You should have received a copy of the GNU General Public License version
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	16 * 2 along with this work; if not, write to the Free Software Foundation,
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	18 *
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	20 * or visit www.oracle.com if you need additional information or have any
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	21 * questions.
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	22 */
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	23 package com.oracle.graal.word;
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	24
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	25 public interface Signed extends WordBase {
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	26
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	27 /**
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	28 * Returns a Signed whose value is {@code (this + val)}.
7530 5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	29 *
7300 2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	30 * @param val value to be added to this Signed.
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	31 * @return {@code this + val}
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	32 */
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	33 Signed add(Signed val);
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	34
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	35 /**
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	36 * Returns a Signed whose value is {@code (this - val)}.
7530 5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	37 *
7300 2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	38 * @param val value to be subtracted from this Signed.
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	39 * @return {@code this - val}
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	40 */
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	41 Signed subtract(Signed val);
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	42
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	43 /**
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	44 * Returns a Signed whose value is {@code (this * val)}.
7530 5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	45 *
7300 2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	46 * @param val value to be multiplied by this Signed.
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	47 * @return {@code this * val}
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	48 */
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	49 Signed multiply(Signed val);
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	50
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	51 /**
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	52 * Returns a Signed whose value is {@code (this / val)}.
7530 5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	53 *
7300 2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	54 * @param val value by which this Signed is to be divided.
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	55 * @return {@code this / val}
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	56 */
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	57 Signed signedDivide(Signed val);
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	58
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	59 /**
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	60 * Returns a Signed whose value is {@code (this % val)}.
7530 5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	61 *
7300 2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	62 * @param val value by which this Signed is to be divided, and the remainder computed.
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	63 * @return {@code this % val}
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	64 */
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	65 Signed signedRemainder(Signed val);
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	66
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	67 /**
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	68 * Returns a Signed whose value is {@code (this << n)}.
7530 5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	69 *
7300 2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	70 * @param n shift distance, in bits.
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	71 * @return {@code this << n}
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	72 */
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	73 Signed shiftLeft(Unsigned n);
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	74
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	75 /**
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	76 * Returns a Signed whose value is {@code (this >> n)}. Sign extension is performed.
7530 5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	77 *
7300 2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	78 * @param n shift distance, in bits.
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	79 * @return {@code this >> n}
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	80 */
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	81 Signed signedShiftRight(Unsigned n);
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	82
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	83 /**
7530 5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	84 * Returns a Signed whose value is {@code (this & val)}. (This method returns a negative Signed
5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	85 * if and only if this and val are both negative.)
5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	86 *
7300 2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	87 * @param val value to be AND'ed with this Signed.
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	88 * @return {@code this & val}
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	89 */
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	90 Signed and(Signed val);
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	91
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	92 /**
7530 5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	93 * Returns a Signed whose value is {@code (this \| val)}. (This method returns a negative Signed
5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	94 * if and only if either this or val is negative.)
5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	95 *
7300 2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	96 * @param val value to be OR'ed with this Signed.
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	97 * @return {@code this \| val}
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	98 */
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	99 Signed or(Signed val);
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	100
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	101 /**
7530 5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	102 * Returns a Signed whose value is {@code (this ^ val)}. (This method returns a negative Signed
5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	103 * if and only if exactly one of this and val are negative.)
5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	104 *
7300 2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	105 * @param val value to be XOR'ed with this Signed.
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	106 * @return {@code this ^ val}
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	107 */
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	108 Signed xor(Signed val);
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	109
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	110 /**
7530 5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	111 * Returns a Signed whose value is {@code (~this)}. (This method returns a negative value if and
5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	112 * only if this Signed is non-negative.)
5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	113 *
7300 2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	114 * @return {@code ~this}
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	115 */
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	116 Signed not();
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	117
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	118 /**
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	119 * Compares this Signed with the specified value.
7530 5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	120 *
7300 2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	121 * @param val value to which this Signed is to be compared.
7701 47467b2c3fc5 Use equal() and notEqual() instead of == and != to compare words Christian Wimmer <christian.wimmer@oracle.com> parents: 7530 diff changeset	122 * @return {@code this == val}
47467b2c3fc5 Use equal() and notEqual() instead of == and != to compare words Christian Wimmer <christian.wimmer@oracle.com> parents: 7530 diff changeset	123 */
47467b2c3fc5 Use equal() and notEqual() instead of == and != to compare words Christian Wimmer <christian.wimmer@oracle.com> parents: 7530 diff changeset	124 boolean equal(Signed val);
47467b2c3fc5 Use equal() and notEqual() instead of == and != to compare words Christian Wimmer <christian.wimmer@oracle.com> parents: 7530 diff changeset	125
47467b2c3fc5 Use equal() and notEqual() instead of == and != to compare words Christian Wimmer <christian.wimmer@oracle.com> parents: 7530 diff changeset	126 /**
47467b2c3fc5 Use equal() and notEqual() instead of == and != to compare words Christian Wimmer <christian.wimmer@oracle.com> parents: 7530 diff changeset	127 * Compares this Signed with the specified value.
47467b2c3fc5 Use equal() and notEqual() instead of == and != to compare words Christian Wimmer <christian.wimmer@oracle.com> parents: 7530 diff changeset	128 *
47467b2c3fc5 Use equal() and notEqual() instead of == and != to compare words Christian Wimmer <christian.wimmer@oracle.com> parents: 7530 diff changeset	129 * @param val value to which this Signed is to be compared.
47467b2c3fc5 Use equal() and notEqual() instead of == and != to compare words Christian Wimmer <christian.wimmer@oracle.com> parents: 7530 diff changeset	130 * @return {@code this != val}
47467b2c3fc5 Use equal() and notEqual() instead of == and != to compare words Christian Wimmer <christian.wimmer@oracle.com> parents: 7530 diff changeset	131 */
47467b2c3fc5 Use equal() and notEqual() instead of == and != to compare words Christian Wimmer <christian.wimmer@oracle.com> parents: 7530 diff changeset	132 boolean notEqual(Signed val);
47467b2c3fc5 Use equal() and notEqual() instead of == and != to compare words Christian Wimmer <christian.wimmer@oracle.com> parents: 7530 diff changeset	133
47467b2c3fc5 Use equal() and notEqual() instead of == and != to compare words Christian Wimmer <christian.wimmer@oracle.com> parents: 7530 diff changeset	134 /**
47467b2c3fc5 Use equal() and notEqual() instead of == and != to compare words Christian Wimmer <christian.wimmer@oracle.com> parents: 7530 diff changeset	135 * Compares this Signed with the specified value.
47467b2c3fc5 Use equal() and notEqual() instead of == and != to compare words Christian Wimmer <christian.wimmer@oracle.com> parents: 7530 diff changeset	136 *
47467b2c3fc5 Use equal() and notEqual() instead of == and != to compare words Christian Wimmer <christian.wimmer@oracle.com> parents: 7530 diff changeset	137 * @param val value to which this Signed is to be compared.
7300 2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	138 * @return {@code this < val}
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	139 */
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	140 boolean lessThan(Signed val);
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	141
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	142 /**
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	143 * Compares this Signed with the specified value.
7530 5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	144 *
7300 2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	145 * @param val value to which this Signed is to be compared.
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	146 * @return {@code this <= val}
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	147 */
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	148 boolean lessOrEqual(Signed val);
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	149
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	150 /**
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	151 * Compares this Signed with the specified value.
7530 5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	152 *
7300 2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	153 * @param val value to which this Signed is to be compared.
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	154 * @return {@code this > val}
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	155 */
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	156 boolean greaterThan(Signed val);
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	157
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	158 /**
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	159 * Compares this Signed with the specified value.
7530 5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	160 *
7300 2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	161 * @param val value to which this Signed is to be compared.
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	162 * @return {@code this >= val}
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	163 */
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	164 boolean greaterOrEqual(Signed val);
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	165
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	166 /**
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	167 * Returns a Signed whose value is {@code (this + val)}.
7530 5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	168 *
7300 2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	169 * @param val value to be added to this Signed.
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	170 * @return {@code this + val}
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	171 */
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	172 Signed add(int val);
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	173
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	174 /**
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	175 * Returns a Signed whose value is {@code (this - val)}.
7530 5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	176 *
7300 2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	177 * @param val value to be subtracted from this Signed.
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	178 * @return {@code this - val}
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	179 */
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	180 Signed subtract(int val);
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	181
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	182 /**
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	183 * Returns a Signed whose value is {@code (this * val)}.
7530 5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	184 *
7300 2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	185 * @param val value to be multiplied by this Signed.
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	186 * @return {@code this * val}
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	187 */
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	188 Signed multiply(int val);
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	189
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	190 /**
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	191 * Returns a Signed whose value is {@code (this / val)}.
7530 5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	192 *
7300 2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	193 * @param val value by which this Signed is to be divided.
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	194 * @return {@code this / val}
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	195 */
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	196 Signed signedDivide(int val);
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	197
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	198 /**
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	199 * Returns a Signed whose value is {@code (this % val)}.
7530 5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	200 *
7300 2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	201 * @param val value by which this Signed is to be divided, and the remainder computed.
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	202 * @return {@code this % val}
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	203 */
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	204 Signed signedRemainder(int val);
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	205
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	206 /**
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	207 * Returns a Signed whose value is {@code (this << n)}.
7530 5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	208 *
7300 2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	209 * @param n shift distance, in bits.
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	210 * @return {@code this << n}
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	211 */
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	212 Signed shiftLeft(int n);
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	213
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	214 /**
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	215 * Returns a Signed whose value is {@code (this >> n)}. Sign extension is performed.
7530 5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	216 *
7300 2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	217 * @param n shift distance, in bits.
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	218 * @return {@code this >> n}
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	219 */
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	220 Signed signedShiftRight(int n);
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	221
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	222 /**
7530 5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	223 * Returns a Signed whose value is {@code (this & val)}. (This method returns a negative Signed
5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	224 * if and only if this and val are both negative.)
5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	225 *
7300 2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	226 * @param val value to be AND'ed with this Signed.
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	227 * @return {@code this & val}
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	228 */
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	229 Signed and(int val);
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	230
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	231 /**
7530 5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	232 * Returns a Signed whose value is {@code (this \| val)}. (This method returns a negative Signed
5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	233 * if and only if either this or val is negative.)
5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	234 *
7300 2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	235 * @param val value to be OR'ed with this Signed.
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	236 * @return {@code this \| val}
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	237 */
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	238 Signed or(int val);
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	239
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	240 /**
7530 5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	241 * Returns a Signed whose value is {@code (this ^ val)}. (This method returns a negative Signed
5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	242 * if and only if exactly one of this and val are negative.)
5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	243 *
7300 2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	244 * @param val value to be XOR'ed with this Signed.
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	245 * @return {@code this ^ val}
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	246 */
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	247 Signed xor(int val);
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	248
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	249 /**
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	250 * Compares this Signed with the specified value.
7530 5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	251 *
7300 2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	252 * @param val value to which this Signed is to be compared.
7701 47467b2c3fc5 Use equal() and notEqual() instead of == and != to compare words Christian Wimmer <christian.wimmer@oracle.com> parents: 7530 diff changeset	253 * @return {@code this == val}
47467b2c3fc5 Use equal() and notEqual() instead of == and != to compare words Christian Wimmer <christian.wimmer@oracle.com> parents: 7530 diff changeset	254 */
47467b2c3fc5 Use equal() and notEqual() instead of == and != to compare words Christian Wimmer <christian.wimmer@oracle.com> parents: 7530 diff changeset	255 boolean equal(int val);
47467b2c3fc5 Use equal() and notEqual() instead of == and != to compare words Christian Wimmer <christian.wimmer@oracle.com> parents: 7530 diff changeset	256
47467b2c3fc5 Use equal() and notEqual() instead of == and != to compare words Christian Wimmer <christian.wimmer@oracle.com> parents: 7530 diff changeset	257 /**
47467b2c3fc5 Use equal() and notEqual() instead of == and != to compare words Christian Wimmer <christian.wimmer@oracle.com> parents: 7530 diff changeset	258 * Compares this Signed with the specified value.
47467b2c3fc5 Use equal() and notEqual() instead of == and != to compare words Christian Wimmer <christian.wimmer@oracle.com> parents: 7530 diff changeset	259 *
47467b2c3fc5 Use equal() and notEqual() instead of == and != to compare words Christian Wimmer <christian.wimmer@oracle.com> parents: 7530 diff changeset	260 * @param val value to which this Signed is to be compared.
47467b2c3fc5 Use equal() and notEqual() instead of == and != to compare words Christian Wimmer <christian.wimmer@oracle.com> parents: 7530 diff changeset	261 * @return {@code this != val}
47467b2c3fc5 Use equal() and notEqual() instead of == and != to compare words Christian Wimmer <christian.wimmer@oracle.com> parents: 7530 diff changeset	262 */
47467b2c3fc5 Use equal() and notEqual() instead of == and != to compare words Christian Wimmer <christian.wimmer@oracle.com> parents: 7530 diff changeset	263 boolean notEqual(int val);
47467b2c3fc5 Use equal() and notEqual() instead of == and != to compare words Christian Wimmer <christian.wimmer@oracle.com> parents: 7530 diff changeset	264
47467b2c3fc5 Use equal() and notEqual() instead of == and != to compare words Christian Wimmer <christian.wimmer@oracle.com> parents: 7530 diff changeset	265 /**
47467b2c3fc5 Use equal() and notEqual() instead of == and != to compare words Christian Wimmer <christian.wimmer@oracle.com> parents: 7530 diff changeset	266 * Compares this Signed with the specified value.
47467b2c3fc5 Use equal() and notEqual() instead of == and != to compare words Christian Wimmer <christian.wimmer@oracle.com> parents: 7530 diff changeset	267 *
47467b2c3fc5 Use equal() and notEqual() instead of == and != to compare words Christian Wimmer <christian.wimmer@oracle.com> parents: 7530 diff changeset	268 * @param val value to which this Signed is to be compared.
7300 2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	269 * @return {@code this < val}
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	270 */
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	271 boolean lessThan(int val);
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	272
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	273 /**
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	274 * Compares this Signed with the specified value.
7530 5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	275 *
7300 2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	276 * @param val value to which this Signed is to be compared.
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	277 * @return {@code this <= val}
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	278 */
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	279 boolean lessOrEqual(int val);
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	280
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	281 /**
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	282 * Compares this Signed with the specified value.
7530 5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	283 *
7300 2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	284 * @param val value to which this Signed is to be compared.
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	285 * @return {@code this > val}
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	286 */
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	287 boolean greaterThan(int val);
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	288
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	289 /**
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	290 * Compares this Signed with the specified value.
7530 5e3d1a68664e applied mx eclipseformat to all Java files Doug Simon <doug.simon@oracle.com> parents: 7300 diff changeset	291 *
7300 2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	292 * @param val value to which this Signed is to be compared.
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	293 * @return {@code this >= val}
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	294 */
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	295 boolean greaterOrEqual(int val);
2912b72d840a More complete and reusable Word type Christian Wimmer <christian.wimmer@oracle.com> parents: diff changeset	296 }

Mercurial > hg > truffle

annotate graal/com.oracle.graal.word/src/com/oracle/graal/word/Signed.java @ 12355:cefad50507d8