Record Class PassConstants

java.lang.Object
java.lang.Record
ffx.numerics.fft.PassConstants
Record Components:
n - The size of the input.
im - The imaginary offset.
nFFTs - The number of FFTs to process (default = 1).
factor - The factor.
product - The product of all factors applied so far.
twiddles - The twiddle factors for this pass.
public record PassConstants(int n, int im, int nFFTs, int factor, int product, double[][] twiddles) extends Record
Constant factors needed for each pass.

  • Constructor Summary

    Constructors
    Constructor
    Description
    PassConstants(int n, int im, int nFFTs, int factor, int product, double[][] twiddles)
    Creates an instance of a PassConstants record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    int
    factor()
    Returns the value of the factor record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    im()
    Returns the value of the im record component.
    int
    n()
    Returns the value of the n record component.
    int
    nFFTs()
    Returns the value of the nFFTs record component.
    int
    product()
    Returns the value of the product record component.
    final String
    toString()
    Returns a string representation of this record class.
    double[][]
    twiddles()
    Returns the value of the twiddles record component.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • PassConstants

      public PassConstants(int n, int im, int nFFTs, int factor, int product, double[][] twiddles)
      Creates an instance of a PassConstants record class.
      Parameters:
      n - the value for the n record component
      im - the value for the im record component
      nFFTs - the value for the nFFTs record component
      factor - the value for the factor record component
      product - the value for the product record component
      twiddles - the value for the twiddles record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • n

      public int n()
      Returns the value of the n record component.
      Returns:
      the value of the n record component

    • im

      public int im()
      Returns the value of the im record component.
      Returns:
      the value of the im record component

    • nFFTs

      public int nFFTs()
      Returns the value of the nFFTs record component.
      Returns:
      the value of the nFFTs record component

    • factor

      public int factor()
      Returns the value of the factor record component.
      Returns:
      the value of the factor record component

    • product

      public int product()
      Returns the value of the product record component.
      Returns:
      the value of the product record component

    • twiddles

      public double[][] twiddles()
      Returns the value of the twiddles record component.
      Returns:
      the value of the twiddles record component