rinde.sim.core.graph.Point Maven / Gradle / Ivy
/**
*
*/
package rinde.sim.core.graph;
import java.io.Serializable;
import javax.annotation.Nullable;
import com.google.common.base.Objects;
/**
* Point represents a position in euclidean space, it is defined as a simple
* tuple (double,double).
* @author Rinde van Lon ([email protected])
*/
public class Point implements Serializable {
private static final String NUM_SEPARATOR = ",";
private static final long serialVersionUID = -7501053764573661924L;
/**
* The x coordinate.
*/
public final double x;
/**
* The y coordinate.
*/
public final double y;
private final int hashCode;
/**
* Create a new point.
* @param pX The x coordinate.
* @param pY The y coordinate.
*/
public Point(double pX, double pY) {
x = pX;
y = pY;
hashCode = Objects.hashCode(x, y);
}
/**
* Computes the distance between two points.
* @param p1 A point.
* @param p2 Another point.
* @return The distance between the two points.
*/
public static double distance(Point p1, Point p2) {
final double dx = p1.x - p2.x;
final double dy = p1.y - p2.y;
return Math.sqrt(dx * dx + dy * dy);
}
/**
* Computes the difference between two points: p1 - p2.
* @param p1 A point.
* @param p2 Another point.
* @return The difference as a point object.
*/
public static Point diff(Point p1, Point p2) {
return new Point(p1.x - p2.x, p1.y - p2.y);
}
/**
* Divides the point, the result is returned as a new point.
* @param p The point to divide.
* @param d The divisor.
* @return A new point containing the result.
*/
public static Point divide(Point p, double d) {
return new Point(p.x / d, p.y / d);
}
/**
* Parses the specified string to a point. Example inputs:
*
* -
(10.0,2)
* -
5,6
* -
(7.3242349832,0
*
* @param pointString The string to parse.
* @return A point.
*/
public static Point parsePoint(String pointString) {
final String[] parts = pointString.replaceAll("\\(|\\)", "").split(
NUM_SEPARATOR);
return new Point(Double.parseDouble(parts[0]), Double.parseDouble(parts[1]));
}
/**
* Duplicates the specified point.
* @param p The point to duplicate.
* @return A duplicate of p.
*/
public static Point duplicate(Point p) {
return new Point(p.x, p.y);
}
@Override
public int hashCode() {
return hashCode;
}
@Override
public boolean equals(@Nullable Object other) {
if (other == null) {
return false;
}
if (other == this) {
return true;
}
// allows comparison with subclasses
if (!(other instanceof Point)) {
return false;
}
final Point p = (Point) other;
return x == p.x && y == p.y;
}
@Override
public String toString() {
return new StringBuilder().append("(").append(x).append(NUM_SEPARATOR)
.append(y).append(")").toString();
}
}