frc.team670.robot.utils.functions

Class MathUtils

java.lang.Object

frc.team670.robot.utils.functions.MathUtils

public class MathUtils
extends java.lang.Object

Provides useful math-related functions.

Author:

shaylandias, meganchoy, varunjoshi

Method Summary

Modifier and Type	Method and Description
static double	average(java.lang.Double... nums) Returns the average value of the input doubles.
static double	average(double[] nums) Returns the average value of the input doubles.
static boolean	doublesEqual(double d1, double d2) Compares two doubles for equality, returning true if they are equal.
static boolean	doublesEqual(double d1, double d2, double comparator) Compares two doubles for equality, returning true if they are equal.
static double	findDistance(double x1, double y1, double x2, double y2) Returns the distance (always positive) between two points in a coordinate system.
static double	findHypotenuse(double leg1, double leg2) Returns the hypotenuse of a triangle given two legs according to the Pythagorean Theorem
static boolean	isWithinTolerance(double value, double target, double tolerance) Returns true if the value is within +/- tolerance of target

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

doublesEqual

public static boolean doublesEqual(double d1,
                                   double d2)

Compares two doubles for equality, returning true if they are equal. Use this since in Java using '==' does not work to compare doubles.

doublesEqual

public static boolean doublesEqual(double d1,
                                   double d2,
                                   double comparator)

Compares two doubles for equality, returning true if they are equal. Use this since in Java using '==' does not work to compare doubles.

Parameters:

d1 -

d2 -

comparator - The value used to compare the doubles after subtracting (ex. 0.0000001). If working with especially small numbers, you would want to set this very low since the difference between them may just be small and not an issue with double comparation.

average

public static double average(double[] nums)

Returns the average value of the input doubles.

average

public static double average(java.lang.Double... nums)

Returns the average value of the input doubles.

findDistance

public static double findDistance(double x1,
                                  double y1,
                                  double x2,
                                  double y2)

Returns the distance (always positive) between two points in a coordinate system.

Parameters:

x1 - The x-coord of point 1

y1 - The y-coord of point 1

x2 - The x-coord of point 2

y2 - The y-coord of point 2

isWithinTolerance

public static boolean isWithinTolerance(double value,
                                        double target,
                                        double tolerance)

Returns true if the value is within +/- tolerance of target

Parameters:

tolerance - The tolerance (must be positive)

findHypotenuse

public static double findHypotenuse(double leg1,
                                    double leg2)

Returns the hypotenuse of a triangle given two legs according to the Pythagorean Theorem

Parameters:

leg1 - The length of the first leg

leg2 - The length of the second leg