Package org.sm.smtools.math

Class Extrema

java.lang.Object
org.sm.smtools.math.Extrema
public final class Extrema
extends java.lang.Object
The Extrema class provides a container for storing local minima and maxima indices and values.

Note that this class cannot be subclassed!

Version:
08/11/2012
Author:
Sven Maerivoet

  • Constructor Summary

    Constructors
    Constructor Description
    Extrema()
    Constructs an empty Extrema object.

  • Method Summary

    Modifier and Type Method Description
    void addLocalMaximum​(int index, double value)
    Adds a local maximum.
    void addLocalMinimum​(int index, double value)
    Adds a local minimum.
    Extremum getLocalMaximum​(int sequenceNumber)
    Returns a local maximum.
    Extremum getLocalMinimum​(int sequenceNumber)
    Returns a local minimum.
    int getNrOfLocalMaxima()
    Returns the number of local maxima available.
    int getNrOfLocalMinima()
    Returns the number of local minima available.
    void reset()
    Resets all local extrema.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Extrema

      public Extrema()
      Constructs an empty Extrema object.

  • Method Details

    • getNrOfLocalMinima

      public int getNrOfLocalMinima()
      Returns the number of local minima available.
      Returns:
      the number of local minima available

    • getNrOfLocalMaxima

      public int getNrOfLocalMaxima()
      Returns the number of local maxima available.
      Returns:
      the number of local maxima available

    • addLocalMinimum

      public void addLocalMinimum​(int index, double value)
      Adds a local minimum.
      Parameters:
      index - the index of the local minimum to set
      value - the value of the local minimum to set

    • addLocalMaximum

      public void addLocalMaximum​(int index, double value)
      Adds a local maximum.
      Parameters:
      index - the index of the local maximum to set
      value - the value of the local maximum to set

    • getLocalMinimum

      public Extremum getLocalMinimum​(int sequenceNumber)
      Returns a local minimum.
      Parameters:
      sequenceNumber - the sequence number of the requested local minimum
      Returns:
      the requested local minimum

    • getLocalMaximum

      public Extremum getLocalMaximum​(int sequenceNumber)
      Returns a local maximum.
      Parameters:
      sequenceNumber - the sequence number of the requested local maximum
      Returns:
      the requested local maximum

    • reset

      public void reset()
      Resets all local extrema.