Package smile.data.formula

Record Class Variable

java.lang.Object
java.lang.Record
smile.data.formula.Variable
Record Components:
name - The variable name.
All Implemented Interfaces:
Serializable, Term
public record Variable(String name) extends Record implements Term
A variable in the formula. A variable can be regarded as the identity function that always returns the same value that was used as its argument.
See Also:

  • Constructor Details

    • Variable

      public Variable(String name)
      Creates an instance of a Variable record class.
      Parameters:
      name - the value for the name record component

  • Method Details

    • toString

      public 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

    • variables

      public Set<String> variables()
      Description copied from interface: Term
      Returns the set of variables used in this term.
      Specified by:
      variables in interface Term
      Returns:
      the set of variables used in this term.

    • bind

      public List<Feature> bind(StructType schema)
      Description copied from interface: Term
      Binds the term to a schema.
      Specified by:
      bind in interface Term
      Parameters:
      schema - the schema to bind the term with.
      Returns:
      the feature list.

    • 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 Objects::equals(Object,Object).
      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.

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component