blob: 666bd1c32ae4d5e928c7af635bfe51cd93e0c080 [file] [log] [blame]
Austin Schuh1e69f942020-11-14 15:06:14 -08001/*----------------------------------------------------------------------------*/
2/* Copyright (c) 2019 FIRST. All Rights Reserved. */
3/* Open Source Software - may be modified and shared by FRC teams. The code */
4/* must be accompanied by the FIRST BSD license file in the root directory of */
5/* the project. */
6/*----------------------------------------------------------------------------*/
7
8package edu.wpi.first.wpiutil.math;
9
10//CHECKSTYLE.OFF: ImportOrder
11{{REPLACEWITHIMPORTS}}
12//CHECKSTYLE.ON
13
14/**
15 * A natural number expressed as a java class.
16 * The counterpart to {@link Num} that should be used as a concrete value.
17 *
18 * @param <T> The {@link Num} this represents.
19 */
20@SuppressWarnings({"MethodName", "unused"})
21public interface Nat<T extends Num> {
22 /**
23 * The number this interface represents.
24 *
25 * @return The number backing this value.
26 */
27 int getNum();