core/com.acmerobotics.roadrunner

Package-level declarations

Types

AccelConstraint

fun interface AccelConstraint

AngularVelConstraint

class AngularVelConstraint(val maxAngVel: Double) : VelConstraint

Arclength

class Arclength

Arclength parameter for DualNum.

ArclengthReparamCurve2d

data class ArclengthReparamCurve2d(val curve: PositionPath<Internal>, val samples: IntegralScanResult) : PositionPath<Arclength>

Arclength reparameterization of curve.

CancelableProfile

class CancelableProfile(val baseProfile: DisplacementProfile, val disps: List<Double>, val minAccels: List<Double>)

Displacement profile that can be canceled at any time to yield a new displacement profile that achieves the final velocity as soon as possible and then promptly ends.

CompositeAccelConstraint

class CompositeAccelConstraint(val constraints: List<AccelConstraint>, val offsets: List<Double>) : AccelConstraint

CompositePosePath

data class CompositePosePath(val paths: List<PosePath>, val offsets: List<Double> = paths.scan(0.0) { acc, path -> acc + path.length() }) : PosePath

CompositePositionPath

data class CompositePositionPath<Param> @JvmOverloads constructor(val paths: List<PositionPath<Param>>, val offsets: List<Double> = paths.scan(0.0) { acc, path -> acc + path.length() }) : PositionPath<Param>

CompositeVelConstraint

class CompositeVelConstraint(val constraints: List<VelConstraint>, val offsets: List<Double>) : VelConstraint

ConstantHeadingPath

data class ConstantHeadingPath(val heading: Rotation2d, val length: Double) : HeadingPath

ConstantPathBuilder

class ConstantPathBuilder

ConstantTrajectoryBuilder

class ConstantTrajectoryBuilder

DisplacementProfile

data class DisplacementProfile(val disps: List<Double>, val vels: List<Double>, val accels: List<Double>)

Acceleration-limited motion profile parameterized by displacement.

DisplacementTrajectory

class DisplacementTrajectory(val path: PosePath, val profile: DisplacementProfile)

DualNum

class DualNum<Param>

HeadingPath

interface HeadingPath

HeadingPosePath

data class HeadingPosePath(val posPath: PositionPath<Arclength>, val headingPath: HeadingPath) : PosePath

HolonomicController

class HolonomicController(val axialPosGain: Double, val lateralPosGain: Double, val headingGain: Double, val axialVelGain: Double, val lateralVelGain: Double, val headingVelGain: Double)

Proportional position-velocity controller for a holonomic robot.

IdentityPoseMap

class IdentityPoseMap : PoseMap

IntegralScanResult

data class IntegralScanResult(val values: List<Double>, val sums: List<Double>)

Internal

class Internal

Generic, internal parameter for DualNum.

Line

data class Line(val begin: Vector2d, val dir: Vector2d, val length: Double) : PositionPath<Arclength>

Line beginning at position begin, pointed in direction dir, and having length length.

LinearHeadingPath

data class LinearHeadingPath(val begin: Rotation2d, val angle: Double, val length: Double) : HeadingPath

MappedPosePath

data class MappedPosePath(val basePath: PosePath, val poseMap: PoseMap) : PosePath

MecanumKinematics

data class MecanumKinematics @JvmOverloads constructor(val trackWidth: Double, val lateralMultiplier: Double = 1.0)

MinMax

data class MinMax(val min: Double, val max: Double)

MinVelConstraint

class MinVelConstraint(val constraints: List<VelConstraint>) : VelConstraint

MotorFeedforward

data class MotorFeedforward(val kS: Double, val kV: Double, val kA: Double)

PathBuilder

class PathBuilder

Pose2d

data class Pose2d(val position: Vector2d, val heading: Rotation2d)

Pose2dDual

data class Pose2dDual<Param>(val position: Vector2dDual<Param>, val heading: Rotation2dDual<Param>)

Dual version of Pose2d.

PoseMap

fun interface PoseMap

PosePath

interface PosePath

PosePathSeqBuilder

class PosePathSeqBuilder

PoseVelocity2d

data class PoseVelocity2d(val linearVel: Vector2d, val angVel: Double)

PoseVelocity2dDual

data class PoseVelocity2dDual<Param>(val linearVel: Vector2dDual<Param>, val angVel: DualNum<Param>)

Dual version of PoseVelocity2d.

PositionPath

interface PositionPath<Param>

PositionPathSeqBuilder

class PositionPathSeqBuilder

PositionPathView

data class PositionPathView<Param>(val path: PositionPath<Param>, val offset: Double, val length: Double) : PositionPath<Param>

ProfileAccelConstraint

class ProfileAccelConstraint(val minAccel: Double, val maxAccel: Double) : AccelConstraint

QuinticSpline1d

data class QuinticSpline1d(val a: Double, val b: Double, val c: Double, val d: Double, val e: Double, val f: Double)

QuinticSpline2d

data class QuinticSpline2d(val x: QuinticSpline1d, val y: QuinticSpline1d) : PositionPath<Internal>

Path comprised of two QuinticSpline1ds.

RamseteController

class RamseteController @JvmOverloads constructor(val trackWidth: Double, val zeta: Double = 0.7, val bBar: Double = 2.0)

RestrictedPathBuilder

class RestrictedPathBuilder

RestrictedPosePathBuilder

class RestrictedPosePathBuilder

Do not instantiate directly. See SafePosePathBuilder.

RestrictedTrajectoryBuilder

class RestrictedTrajectoryBuilder

Rotation2d

data class Rotation2d(val real: Double, val imag: Double)

Rotation2dDual

data class Rotation2dDual<Param>(val real: DualNum<Param>, val imag: DualNum<Param>)

Dual version of Rotation2d.

SafePathBuilder

class SafePathBuilder

SafePosePathBuilder

class SafePosePathBuilder

Wrapper for PosePathSeqBuilder that provides the same guarantees without throwing PosePathSeqBuilder.RotationContinuityException.

SafeTrajectoryBuilder

class SafeTrajectoryBuilder

SplineHeadingPath

data class SplineHeadingPath(val begin: Rotation2d, val spline: QuinticSpline1d, val length: Double) : HeadingPath

TangentPath

data class TangentPath(val path: PositionPath<Arclength>, val offset: Double) : PosePath

TangentPathBuilder

class TangentPathBuilder

TangentTrajectoryBuilder

class TangentTrajectoryBuilder

TankKinematics

data class TankKinematics(val trackWidth: Double)

Time

class Time

Time parameter for DualNum.

TimeProfile

data class TimeProfile @JvmOverloads constructor(val dispProfile: DisplacementProfile, val times: List<Double> = timeScan(dispProfile))

Acceleration-limited motion profile parameterized by time.

TimeTrajectory

class TimeTrajectory(val path: PosePath, val profile: TimeProfile)

Trajectory

class Trajectory(val path: MappedPosePath, val profile: CancelableProfile, val offsets: List<Double>)

TrajectoryBuilder

class TrajectoryBuilder

TranslationalVelConstraint

class TranslationalVelConstraint(val minTransVel: Double) : VelConstraint

Twist2d

data class Twist2d(val line: Vector2d, val angle: Double)

Twist2dDual

data class Twist2dDual<Param>(val line: Vector2dDual<Param>, val angle: DualNum<Param>)

Vector2d

data class Vector2d(val x: Double, val y: Double)

Vector2dDual

data class Vector2dDual<Param>(val x: DualNum<Param>, val y: DualNum<Param>)

Dual version of Vector2d.

VelConstraint

fun interface VelConstraint

Functions

backwardProfile

fun backwardProfile(disps: List<Double>, maxVels: List<Double>, endVel: Double, minAccels: List<Double>): DisplacementProfile

Computes an approximately time-optimal backward profile from the center-sampled constraints. No restriction is imposed on the maximum acceleration.

fun backwardProfile(length: Double, maxVel: (Double) -> Double, endVel: Double, minAccel: (Double) -> Double, resolution: Double): DisplacementProfile

Computes an approximately time-optimal backward profile by sampling the constraints according to the resolution resolution. No restriction is imposed on the minimum acceleration.

fun backwardProfile(path: PosePath, velConstraint: VelConstraint, endVel: Double, accelConstraint: AccelConstraint, dispResolution: Double, angResolution: Double): DisplacementProfile

clamp

fun clamp(x: Double, lo: Double, hi: Double): Double

constantProfile

fun constantProfile(length: Double, beginEndVel: Double, maxVel: Double, minAccel: Double, maxAccel: Double): CancelableProfile

Computes an exact, time-optimal profile.

forwardProfile

fun forwardProfile(disps: List<Double>, beginVel: Double, maxVels: List<Double>, maxAccels: List<Double>): DisplacementProfile

Computes an approximately time-optimal forward profile from the center-sampled constraints. No restriction is imposed on the minimum acceleration.

fun forwardProfile(length: Double, beginVel: Double, maxVel: (Double) -> Double, maxAccel: (Double) -> Double, resolution: Double): DisplacementProfile

Computes an approximately time-optimal forward profile by sampling the constraints according to the resolution resolution. No restriction is imposed on the minimum acceleration.

fun forwardProfile(path: PosePath, beginVel: Double, velConstraint: VelConstraint, accelConstraint: AccelConstraint, dispResolution: Double, angResolution: Double): DisplacementProfile

integralScan

fun integralScan(a: Double, b: Double, eps: Double, f: (Double) -> Double): IntegralScanResult

lerp

fun lerp(x: Double, fromLo: Double, fromHi: Double, toLo: Double, toHi: Double): Double

lerpLookup

fun lerpLookup(source: List<Double>, target: List<Double>, query: Double): Double

lerpLookupMap

fun lerpLookupMap(source: List<Double>, target: List<Double>, queries: List<Double>): List<Double>

map

fun PoseMap.map(pose: Pose2d): Pose2d

merge

fun merge(p1: DisplacementProfile, p2: DisplacementProfile): DisplacementProfile

Merges p1 and p2 into another profile with the minimum velocity of the two at every point.

profile

fun profile(disps: List<Double>, beginEndVel: Double, maxVels: List<Double>, minAccels: List<Double>, maxAccels: List<Double>): CancelableProfile

Computes an approximately time-optimal profile from sampled constraints.

fun profile(path: PosePath, beginEndVel: Double, velConstraint: VelConstraint, accelConstraint: AccelConstraint, dispResolution: Double, angResolution: Double): CancelableProfile

fun profile(length: Double, beginEndVel: Double, maxVel: (Double) -> Double, minAccel: (Double) -> Double, maxAccel: (Double) -> Double, resolution: Double): CancelableProfile

Computes an approximately time-optimal profile by sampling the constraints according to the resolution resolution.

project

fun project(path: PosePath, query: Vector2d, init: Double): Double

fun project(path: PositionPath<Arclength>, query: Vector2d, init: Double): Double

Project position query onto position path path starting with initial guess init.

range

fun range(begin: Double, end: Double, samples: Int): List<Double>

rangeCentered

fun rangeCentered(begin: Double, end: Double, samples: Int): List<Double>

samplePathByRotation

fun samplePathByRotation(path: PosePath, angResolution: Double): List<Double>

snz

fun snz(x: Double): Double