Enum FFT.LMode

java.lang.Object
java.lang.Enum<FFT.LMode>
org.bzdev.math.FFT.LMode
All Implemented Interfaces:
Serializable, Comparable<FFT.LMode>
Enclosing class:
FFT

public static enum FFT.LMode extends Enum<FFT.LMode>
FFT length mode. This enumeration type is used to control a search for an FFT provider.
See Also:
  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    Indicate that a length argument represents the desired length for the real and imaginary arrays used as inputs or outputs to a transform.
    Indicate that the length argument represents a a length that the FFT provider must support.
    Indicate that a length argument represents the maximum length for the real and imaginary arrays used as inputs or outputs to a transform.
  • Method Summary

    Modifier and Type
    Method
    Description
    static FFT.LMode
    Returns the enum constant of this type with the specified name.
    static FFT.LMode[]
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • DESIRED_LENGTH

      public static final FFT.LMode DESIRED_LENGTH
      Indicate that a length argument represents the desired length for the real and imaginary arrays used as inputs or outputs to a transform. Subject to other constraints, FFT.getServiceName(int,boolean,LMode) will choose an FFT provider that can provide a transform with a length as large or larger than the desired length, but as close to the desired length as possible.
    • EXACT_LENGTH

      public static final FFT.LMode EXACT_LENGTH
      Indicate that the length argument represents a a length that the FFT provider must support. Subject to other constraints, FFT.getServiceName(int,boolean,LMode) will choose an FFT provider that can provide a transform with a length with the specified value.
    • MAX_LENGTH

      public static final FFT.LMode MAX_LENGTH
      Indicate that a length argument represents the maximum length for the real and imaginary arrays used as inputs or outputs to a transform. Subject to other constraints, FFT.getServiceName(int,boolean,LMode) will choose an FFT provider that can provide a transform with a length as large or larger than the maximum length.
  • Method Details

    • values

      public static FFT.LMode[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static FFT.LMode valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null