Record Class OMP.Options

java.lang.Object
java.lang.Record
smile.cs.OMP.Options
Record Components:
sparsity - the target sparsity k (maximum number of non-zero components). The algorithm terminates once k atoms have been selected, unless the residual tolerance is reached first.
tol - residual tolerance. The algorithm stops early if ‖residual‖₂ / ‖y‖₂ < tol.
Enclosing class:
OMP
public static record OMP.Options(int sparsity, double tol) extends Record
Hyperparameters for OMP.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Options(int sparsity, double tol)
    Constructs options.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    static OMP.Options
    of(Properties props)
    Creates options from properties.
    int
    sparsity()
    Returns the value of the sparsity record component.
    double
    tol()
    Returns the value of the tol record component.
    Properties
    toProperties()
    Returns properties for persistence.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Constructor Details

    • Options

      public Options(int sparsity, double tol)
      Constructs options.

  • Method Details

    • toProperties

      public Properties toProperties()
      Returns properties for persistence.
      Returns:
      the properties.

    • of

      public static OMP.Options of(Properties props)
      Creates options from properties.
      Parameters:
      props - the properties.
      Returns:
      the options.

    • 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. All components in this record class 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.

    • sparsity

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

    • tol

      public double tol()
      Returns the value of the tol record component.
      Returns:
      the value of the tol record component