Package com.team2813.lib2813.util

Class ControlUtils

java.lang.Object
com.team2813.lib2813.util.ControlUtils
public class ControlUtils extends Object
Utility class for comon control-related utility functions.

  • Method Summary

    Modifier and Type
    Method
    Description
    static double
    deadband(double value, double deadband)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Use edu.wpi.first.math.MathUtil.applyDeadband instead.

    Methods inherited from class java.lang.Object

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

  • Method Details

    • deadband

      @Deprecated(forRemoval=true) public static double deadband(double value, double deadband)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use edu.wpi.first.math.MathUtil.applyDeadband instead.
      Deadbands a value.

      "A deadband or dead-band (also known as a dead zone or a neutral zone) is a band of input values in the domain of a transfer function in a control system or signal processing system where the output is zero (the output is 'dead' - no action occurs).". See https://en.wikipedia.org/wiki/Deadband.

      Parameters:
      value - The value to deadband, must be in [-1.0, 1.0].
      deadband - The deadband range value, must be in [0.0, 1.0).
      Returns:
      The deadbanded value.
      Throws:
      IllegalArgumentException - If the value or deadband is out of bounds.
      See Also: