001// Copyright (c) FIRST and other WPILib contributors.
002// Open Source Software; you can modify and/or share it under the terms of
003// the WPILib BSD license file in the root directory of this project.
004
005package edu.wpi.first.util.function;
006
007/**
008 * Represents a supplier of float-valued results.
009 *
010 * <p>This is the float-producing primitive specialization of {@link java.util.function.Supplier}.
011 *
012 * <p>There is no requirement that a distinct result be returned each time the supplier is invoked.
013 *
014 * <p>This is a functional interface whose functional method is {@link #getAsFloat()}.
015 */
016@FunctionalInterface
017public interface FloatSupplier {
018  /**
019   * Gets a result.
020   *
021   * @return a result
022   */
023  float getAsFloat();
024}