Record Class RowIndex

java.lang.Object
java.lang.Record
smile.data.RowIndex
Record Components:
values - the row index values.
loc - the map of row index value to ordinal index.
All Implemented Interfaces:
Serializable
public record RowIndex(Object[] values, Map<Object,Integer> loc) extends Record implements Serializable
DataFrame row index. A data frame may have a vector of row labels which has same length as the number of rows in the data frame, and contains neither missing nor duplicated values.
See Also:

  • Constructor Details

    • RowIndex

      public RowIndex(Object[] values)
      Constructor.
      Parameters:
      values - the row values.

    • RowIndex

      public RowIndex(Object[] values, Map<Object,Integer> loc)
      Creates an instance of a RowIndex record class.
      Parameters:
      values - the value for the values record component
      loc - the value for the loc record component

  • Method Details

    • size

      public int size()
      Returns the number of elements in the index.
      Returns:
      the number of elements in the index.

    • apply

      public int apply(Object label)
      Returns the row index.
      Parameters:
      label - the row label.
      Returns:
      the row index.

    • containsKey

      public boolean containsKey(Object label)
      Returns true if the index contains the given label.
      Parameters:
      label - the row label.
      Returns:
      true if the label exists in the index.

    • getOrDefault

      public int getOrDefault(Object label)
      Returns the row index, or -1 if not found.
      Parameters:
      label - the row label.
      Returns:
      the row index, or -1 if not found.

    • get

      public RowIndex get(Index index)
      Returns a slice of the index.
      Parameters:
      index - the index to selected rows.
      Returns:
      a slice of the index.

    • 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 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.

    • values

      public Object[] values()
      Returns the value of the values record component.
      Returns:
      the value of the values record component

    • loc

      public Map<Object,Integer> loc()
      Returns the value of the loc record component.
      Returns:
      the value of the loc record component