acm.graphics.GMath Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of javakarel Show documentation
Show all versions of javakarel Show documentation
This the original Stanford Karel for Java, packaged for Maven. ACM Library is included. See also https://cs.stanford.edu/people/eroberts/karel-the-robot-learns-java.pdf
The newest version!
/*
* @(#)GMath.java 1.99.1 08/12/08
*/
// ************************************************************************
// * Copyright (c) 2008 by the Association for Computing Machinery *
// * *
// * The Java Task Force seeks to impose few restrictions on the use of *
// * these packages so that users have as much freedom as possible to *
// * use this software in constructive ways and can make the benefits of *
// * that work available to others. In view of the legal complexities *
// * of software development, however, it is essential for the ACM to *
// * maintain its copyright to guard against attempts by others to *
// * claim ownership rights. The full text of the JTF Software License *
// * is available at the following URL: *
// * *
// * http://www.acm.org/jtf/jtf-software-license.pdf *
// * *
// ************************************************************************
// REVISION HISTORY
//
// -- V2.0 --
// Bug fix 15-Aug-07 (ESR, JTFBug 2007-011, reported by William Slough)
// 1. Fixed comments that referred to incorrect trigonometric functions.
package acm.graphics;
/* Class: GMath */
/**
* This class defines a variety of static mathematical methods
* that are useful for the acm.graphics package.
*/
public class GMath {
/* Private constructor: GMath() */
/**
* Prevents clients from instantiating this class.
*/
private GMath() {
/* Empty */
}
/* Static method: round(x) */
/**
* Rounds a double value to the nearest int.
*
* Example: int n = round(x);
* @param x A double value
* @return The nearest int value
*/
public static int round(double x) {
return (int) Math.round(x);
}
/* Static method: sinDegrees(angle) */
/**
* Returns the trigonometric sine of its argument where angle
* is expressed in degrees.
*
* Example: double s = sinDegrees(angle);
* @param angle An angle measured in degrees
* @return The trigonometric sine of the angle
*/
public static double sinDegrees(double angle) {
return Math.sin(toRadians(angle));
}
/* Static method: cosDegrees(angle) */
/**
* Returns the trigonometric cosine of its argument where angle
* is expressed in degrees.
*
* Example: double c = cosDegrees(angle);
* @param angle An angle measured in degrees
* @return The trigonometric cosine of the angle
*/
public static double cosDegrees(double angle) {
return Math.cos(toRadians(angle));
}
/* Static method: tanDegrees(angle) */
/**
* Returns the trigonometric tangent of its argument where angle
* is expressed in degrees.
*
* Example: double t = tanDegrees(angle);
* @param angle An angle measured in degrees
* @return The trigonometric tangent of the angle
*/
public static double tanDegrees(double angle) {
return sinDegrees(angle) / cosDegrees(angle);
}
/* Static method: toDegrees(radians) */
/**
* Converts an angle from radians to degrees. This method is defined in
* the Math class, but was added only in JDK1.2, which is not
* supported in all browsers.
*
* Example: double degrees = toDegrees(radians);
* @param radians An angle measured in radians
* @return The equivalent angle in degrees
*/
public static double toDegrees(double radians) {
return radians * 180 / Math.PI;
}
/* Static method: toRadians(degrees) */
/**
* Converts an angle from degrees to radians. This method is defined in
* the Math class, but was added only in JDK1.2, which is not
* supported in all browsers.
*
* Example: double radians = toRadians(degrees);
* @param degrees An angle measured in degrees
* @return The equivalent angle in radians
*/
public static double toRadians(double degrees) {
return degrees * Math.PI / 180;
}
/* Static method: distance(x, y) */
/**
* Computes the distance between the origin and the point
* (x, y).
*
* Example: double d = distance(x, y);
* @param x The x-coordinate of the point
* @param y The y-coordinate of the point
* @return The distance from the origin to the point (x, y)
*/
public static double distance(double x, double y) {
return Math.sqrt(x * x + y * y);
}
/* Static method: distance(x0, y0, x1, y1) */
/**
* Computes the distance between the points (x0, y0)
* and (x1, y1).
*
* Example: double d = distance(x0, y0, x1, y1);
* @param x0 The x-coordinate of one point
* @param y0 The y-coordinate of that point
* @param x1 The x-coordinate of the other point
* @param y1 The y-coordinate of that point
* @return The distance between the points (x0, y0) and
* (x1, y1)
*/
public static double distance(double x0, double y0, double x1, double y1) {
return distance(x1 - x0, y1 - y0);
}
/* Static method: angle(x, y) */
/**
* Returns the angle in degrees from the origin to the point
* (x, y). This method is easier to use than
* atan2 because it specifies the displacements in the usual
* x/y order and because it takes care of the fact that the Java coordinate
* system is flipped. The point (0, 0) is arbitrarily defined to be at
* angle 0.
*
* Example: double theta = angle(x, y);
* @param x The x-coordinate of the point
* @param y The y-coordinate of the point
* @return The angle from the origin to the point (x, y)
* measured in degrees counterclockwise from the +x axis
*/
public static double angle(double x, double y) {
if (x == 0 && y == 0) return 0;
return toDegrees(Math.atan2(-y, x));
}
/* Static method: angle(x0, y0, x1, y1) */
/**
* Computes the angle in degrees formed by a line segment from the
* point (x0, y0) and
* (x1, y1).
*
* Example: double theta = angle(x0, y0, x1, y1);
* @param x0 The x-coordinate of one point
* @param y0 The y-coordinate of that point
* @param x1 The x-coordinate of the other point
* @param y1 The y-coordinate of that point
* @return The angle formed by the line segment from
* (x0, y0) to
* (x1, y1)
*/
public static double angle(double x0, double y0, double x1, double y1) {
return angle(x1 - x0, y1 - y0);
}
}