Package frc.spectrumLib.util

Class Util

java.lang.Object

frc.spectrumLib.util.Util

public class Util
extends Object

From 254 lib imported from 1678-2024 Contains basic functions that are used often.

Field Summary

Fields

Modifier and Type	Field	Description
static final Trigger	autoMode	Trigger that is true when the robot is enabled in autonomous mode.
static final Trigger	disabled	Trigger that is true when the robot is disabled.
static final Trigger	dsAttached	Trigger that is true when the DriverStation is attached.
static final double	EPSILON
static final Trigger	teleop	Trigger that is true when the robot is enabled in teleop mode.
static final Trigger	testMode	Trigger that is true when the robot is enabled in test mode.

Method Summary

Modifier and Type	Method	Description
static boolean	allCloseTo(List<Double> list, double value, double epsilon)
static boolean	epsilonEquals(double a, double b)
static boolean	epsilonEquals(double a, double b, double epsilon)
static boolean	epsilonEquals(int a, int b, int epsilon)
static boolean	inRange(double v, double maxMagnitude)
static boolean	inRange(double v, double min, double max)	Checks if the given input is within the range (min, max), both exclusive.
static boolean	inRange(DoubleSupplier v, DoubleSupplier min, DoubleSupplier max)
static double	interpolate(double a, double b, double x)
static String	joinStrings(String delim, List<?> strings)
static double	limit(double v, double maxMagnitude)	Limits the given input to the given magnitude.
static double	limit(double v, double min, double max)

Methods inherited from class java.lang.Object

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

Field Details

EPSILON

public static final double EPSILON

See Also:

• Constant Field Values

teleop

public static final Trigger teleop

Trigger that is true when the robot is enabled in teleop mode.

autoMode

public static final Trigger autoMode

Trigger that is true when the robot is enabled in autonomous mode.

testMode

public static final Trigger testMode

Trigger that is true when the robot is enabled in test mode.

disabled

public static final Trigger disabled

Trigger that is true when the robot is disabled.

dsAttached

public static final Trigger dsAttached

Trigger that is true when the DriverStation is attached.

Method Details

limit

public static double limit(double v,
 double maxMagnitude)

Limits the given input to the given magnitude.

limit

public static double limit(double v,
 double min,
 double max)

inRange

public static boolean inRange(double v,
 double maxMagnitude)

inRange

public static boolean inRange(double v,
 double min,
 double max)

Checks if the given input is within the range (min, max), both exclusive.

inRange

public static boolean inRange(DoubleSupplier v,
 DoubleSupplier min,
 DoubleSupplier max)

interpolate

public static double interpolate(double a,
 double b,
 double x)

joinStrings

public static String joinStrings(String delim,
 List<?> strings)

epsilonEquals

public static boolean epsilonEquals(double a,
 double b,
 double epsilon)

epsilonEquals

public static boolean epsilonEquals(double a,
 double b)

epsilonEquals

public static boolean epsilonEquals(int a,
 int b,
 int epsilon)

allCloseTo

public static boolean allCloseTo(List<Double> list,
 double value,
 double epsilon)