uk.ac.sussex.gdsc.smlm.results.count.ConsecutiveFailCounter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gdsc-smlm Show documentation
Genome Damage and Stability Centre SMLM Package Software for single molecule localisation microscopy (SMLM)
The newest version!
/*-
 * #%L
 * Genome Damage and Stability Centre SMLM Package
 *
 * Software for single molecule localisation microscopy (SMLM)
 * %%
 * Copyright (C) 2011 - 2023 Alex Herbert
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this program.  If not, see
 * .
 * #L%
 */

package uk.ac.sussex.gdsc.smlm.results.count;

/**
 * Stop evaluating when a number of consecutive failures is exceeded.
 */
public final class ConsecutiveFailCounter extends BaseFailCounter {
  /** The fail count. */
  private int failCount;

  /** The number of allowed failures. */
  private final int allowedFailures;

  /**
   * Instantiates a new consecutive fail counter.
   *
   * @param allowedFailures the number of allowed failures
   */
  private ConsecutiveFailCounter(int allowedFailures) {
    this.allowedFailures = allowedFailures;
  }

  @Override
  protected String generateDescription() {
    return "consecutiveFailures=" + allowedFailures;
  }

  /**
   * Instantiates a new consecutive fail counter.
   *
   * The {@code allowedFailures} specifies the number of failures allowed before a fail status.
   * Use of zero will fail on the first failure; use of one will fail on the second consecutive
   * failure.
   *
   * @param allowedFailures the number of allowed failures before failure
   * @return the consecutive fail counter
   */
  public static ConsecutiveFailCounter create(int allowedFailures) {
    return new ConsecutiveFailCounter(Math.max(0, allowedFailures));
  }

  @Override
  public void pass() {
    failCount = 0;
  }

  @Override
  public void pass(int n) {
    failCount = 0;
  }

  @Override
  public void fail() {
    if (failCount == Integer.MAX_VALUE) {
      throw new IllegalStateException("Unable to increment");
    }
    failCount++;
  }

  @Override
  public void fail(int n) {
    if (n < 0) {
      throw new IllegalArgumentException("Number of fails must be positive");
    }
    if (Integer.MAX_VALUE - n < failCount) {
      throw new IllegalStateException("Unable to increment");
    }
    failCount += n;
  }

  @Override
  public boolean isOk() {
    return failCount <= allowedFailures;
  }

  @Override
  public FailCounter newCounter() {
    return new ConsecutiveFailCounter(allowedFailures);
  }

  @Override
  public void reset() {
    failCount = 0;
  }

  /**
   * Gets the fail count.
   *
   * @return the fail count
   */
  public int getFailCount() {
    return failCount;
  }

  /**
   * Gets the number of allowed failures.
   *
   * @return the number of allowed failures.
   */
  public int getAllowedFailures() {
    return allowedFailures;
  }
}