com.samskivert.util.IntTuple Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of samskivert Show documentation

A collection of Java utilities.

There is a newer version: 1.9

//
// $Id$
//
// samskivert library - useful routines for java programs
// Copyright (C) 2001-2011 Michael Bayne, et al.
//
// This library is free software; you can redistribute it and/or modify it
// under the terms of the GNU Lesser General Public License as published
// by the Free Software Foundation; either version 2.1 of the License, or
// (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

package com.samskivert.util;

import java.io.Serializable;

/**
 * A simple object that holds a reference to two ints.
 */
public class IntTuple
    implements Comparable, Serializable
{
    /** The left int. */
    public int left;

    /** The right int. */
    public int right;

    /** Construct a tuple with the specified two objects. */
    public IntTuple (int left, int right)
    {
        this.left = left;
        this.right = right;
    }

    /** Construct a blank tuple. */
    public IntTuple ()
    {
    }

    /**
     * Returns the combined hashcode of the two elements.
     */
    @Override
    public int hashCode ()
    {
        return left ^ right;
    }

    // documentation inherited from interface
    public int compareTo (IntTuple ot)
    {
        return (left == ot.left) ? (right - ot.right) : (left - ot.left);
    }

    /**
     * A tuple is equal to another tuple if the left and right elements
     * are equal to the left and right elements (respectively) of the
     * other tuple.
     */
    @Override
    public boolean equals (Object other)
    {
        if (other instanceof IntTuple) {
            IntTuple to = (IntTuple)other;
            return (left == to.left && right == to.right);
        } else {
            return false;
        }
    }

    @Override
    public String toString ()
    {
        return "[left=" + left + ", right=" + right + "]";
    }
}