org.xmlcml.euclid

Class Int2

java.lang.Object

org.xmlcml.euclid.Int2

All Implemented Interfaces:

EuclidConstants

public class Int2
extends Object
implements EuclidConstants

A pair of integers with no other assumptions Contains two ints. The default value is 0, 0.

Author:

(C) P. Murray-Rust, 1996

Field Summary

Fields inherited from interface org.xmlcml.euclid.EuclidConstants

C_AMP, C_APOS, C_ATSIGN, C_BACKSLASH, C_BACKSPACE, C_CARET, C_COLON, C_COMMA, C_DEL, C_DOLLAR, C_EQUALS, C_FORMFEED, C_HASH, C_LANGLE, C_LBRAK, C_LCURLY, C_LSQUARE, C_MINUS, C_NBSP, C_NEWLINE, C_NL, C_PERCENT, C_PERIOD, C_PIPE, C_PLUS, C_POUND, C_QUERY, C_QUOT, C_RANGLE, C_RBRAK, C_RCURLY, C_RETURN, C_RSQUARE, C_SEMICOLON, C_SHRIEK, C_SLASH, C_SPACE, C_STAR, C_TAB, C_TILDE, C_UNDER, EPS, F_S, NONWHITEPUNC, NONWHITEPUNC0, NONWHITEPUNC0REGEX, ONE_THIRD, PUNC, S_AMP, S_APOS, S_ATSIGN, S_BACKSLASH, S_CARET, S_COLON, S_COMMA, S_DOLLAR, S_EMPTY, S_EQUALS, S_FORMFEED, S_HASH, S_LANGLE, S_LBRAK, S_LCURLY, S_LSQUARE, S_MINUS, S_NEWLINE, S_NL, S_PERCENT, S_PERIOD, S_PIPE, S_PLUS, S_POUND, S_QUERY, S_QUOT, S_RANGLE, S_RBRAK, S_RCURLY, S_RETURN, S_RSQUARE, S_SEMICOLON, S_SHRIEK, S_SLASH, S_SPACE, S_STAR, S_TAB, S_TILDE, S_UNDER, S_WHITEREGEX, TWO_THIRDS, U_S, WHITESPACE

Constructor Summary

Constructors

Constructor and Description
Int2() constructor.
Int2(Int2 r) copy constructor
Int2(int x, int y) constructor.

Method Summary

Modifier and Type	Method and Description
void	clear() set to 0, 0
Int2	decrementX() subtracts 1 from x value.
Int2	decrementY() subtracts 1 from y value.
int	dotProduct(Int2 r) get dot product
int	elementAt(int elem) get either value; counts from ZERO
boolean	equals(Object obj)
double	getEuclideanDistance(Int2 int2)
static Int2	getInt2(Real2 xy2) cast a Real2 into an Int2.
double	getManhattanDistance(Int2 int2)
Int2	getMidPoint(Int2 p) point midway between 'this' and 'p'
int	getX() get X value
int	getY() get Y value
int	hashCode()
Int2	incrementX() adds 1 to x value.
Int2	incrementY() adds 1 to y value.
static boolean	isEqual(Int2 xy0, Int2 xy1) compares two Int2s.
boolean	isEqualTo(Int2 r) is equal to.
Int2	multiplyBy(int f) multiply a point by a scalar
void	negative() multiply both components by minus one MODIFIES 'this'
Int2	plus(Int2 r2) add two points to give vector sum
void	setX(int xx) set x.
void	setY(int yy) set y.
void	sortAscending() sorts x and y so that x <= y
void	sortDescending() sorts x and y so that x >= y
Int2	subtract(Int2 r2) subtract two points to give vector difference
void	swap() swaps the x and y values
String	toString() to string.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Int2

public Int2()

constructor.

Int2

public Int2(int x,
            int y)

constructor.

Parameters:

x -

y -

Int2

public Int2(Int2 r)

copy constructor

Parameters:

r -

Method Detail

getInt2

public static Int2 getInt2(Real2 xy2)

cast a Real2 into an Int2.

Parameters:

xy2 -

Returns:

null if argument is null

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

swap

public void swap()

swaps the x and y values

sortAscending

public void sortAscending()

sorts x and y so that x <= y

sortDescending

public void sortDescending()

sorts x and y so that x >= y

clear

public void clear()

set to 0, 0

setX

public void setX(int xx)

set x.

Parameters:

xx -

setY

public void setY(int yy)

set y.

Parameters:

yy -

isEqualTo

public boolean isEqualTo(Int2 r)

is equal to.

Parameters:

r -

Returns:

true if equal

plus

public Int2 plus(Int2 r2)

add two points to give vector sum

Parameters:

r2 -

Returns:

new point

subtract

public Int2 subtract(Int2 r2)

subtract two points to give vector difference

Parameters:

r2 -

Returns:

point

negative

public void negative()

multiply both components by minus one MODIFIES 'this'

multiplyBy

public Int2 multiplyBy(int f)

multiply a point by a scalar

Parameters:

f -

Returns:

point

getX

public int getX()

get X value

Returns:

value

getY

public int getY()

get Y value

Returns:

value

elementAt

public int elementAt(int elem)
              throws EuclidRuntimeException

get either value; counts from ZERO

Parameters:

elem -

Returns:

element

Throws:

EuclidRuntimeException

getMidPoint

public Int2 getMidPoint(Int2 p)

point midway between 'this' and 'p'

Parameters:

p -

Returns:

midpoint

dotProduct

public int dotProduct(Int2 r)

get dot product

Parameters:

r -

Returns:

dot

toString

public String toString()

to string.

Overrides:

toString in class Object

Returns:

string

getEuclideanDistance

public double getEuclideanDistance(Int2 int2)

getManhattanDistance

public double getManhattanDistance(Int2 int2)

incrementX

public Int2 incrementX()

adds 1 to x value. changes this

decrementX

public Int2 decrementX()

subtracts 1 from x value. changes this

incrementY

public Int2 incrementY()

adds 1 to y value. changes this

decrementY

public Int2 decrementY()

subtracts 1 from y value. changes this

isEqual

public static boolean isEqual(Int2 xy0,
                              Int2 xy1)

compares two Int2s. Any null values return false.

Parameters:

xy0 -

xy1 -

Returns: