org.josef.science.math.geometry

Class CPoint

java.lang.Object

org.josef.science.math.geometry.CPoint

All Implemented Interfaces:

Serializable

@Status(stage=DEVELOPMENT,
        unitTests=COMPLETE)
 @ThreadSafety(level=IMMUTABLE)
public class CPoint
extends Object
implements Serializable

Abstraction of a point in two dimensions.

Version:

1.0 $Revision: 5460 $

Author:

Kees Schotanus

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CPoint(double x, double y) Creates this CPoint from the supplied x coordinate and y coordinate.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object point) Determines whether this CPoint is equal to the supplied point.
double	getX() Gets the x coordinate of this CPoint.
double	getY() Gets the y coordinate of this CPoint.
int	hashCode() Computes the hash code of this CPoint.
String	toString() Creates a String representation of this CPoint.

Methods inherited from class java.lang.Object

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

Constructor Detail

CPoint

public CPoint(double x,
              double y)

Creates this CPoint from the supplied x coordinate and y coordinate.

Parameters:

x - The x coordinate.

y - The y coordinate.

Method Detail

getX

public double getX()

Gets the x coordinate of this CPoint.

Returns:

The x coordinate of this CPoint.

getY

public double getY()

Gets the y coordinate of this CPoint.

Returns:

The y coordinate of this CPoint.

equals

public boolean equals(Object point)

Determines whether this CPoint is equal to the supplied point.

Overrides:

equals in class Object

Parameters:

point - The point to compare to this CPoint.

Returns:

True when the supplied point is non-null, is of type CPoint and both the x and the y coordinate of both points are the same.
Otherwise false is returned.

hashCode

public int hashCode()

Computes the hash code of this CPoint.

Overrides:

hashCode in class Object

Returns:

The hash code of this CPoint.

toString

public String toString()

Creates a String representation of this CPoint.
The format of the returned String is CPoint(x,y).

Overrides:

toString in class Object

Returns:

A String representation of this CPoint.