Record Class ConfusionMatrix

java.lang.Object
java.lang.Record
smile.validation.metric.ConfusionMatrix
Record Components:
matrix - the confusion matrix.
All Implemented Interfaces:
Serializable
public record ConfusionMatrix(int[][] matrix) extends Record implements Serializable
The confusion matrix of truth and predictions.
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    ConfusionMatrix(int[][] matrix)
    Creates an instance of a ConfusionMatrix record class.

  • 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.
    int[][]
    matrix()
    Returns the value of the matrix record component.
    static ConfusionMatrix
    of(int[] truth, int[] prediction)
    Creates the confusion matrix.
    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

    • ConfusionMatrix

      public ConfusionMatrix(int[][] matrix)
      Creates an instance of a ConfusionMatrix record class.
      Parameters:
      matrix - the value for the matrix record component

  • Method Details

    • of

      public static ConfusionMatrix of(int[] truth, int[] prediction)
      Creates the confusion matrix.
      Parameters:
      truth - the ground truth.
      prediction - the prediction.
      Returns:
      the confusion matrix.

    • 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

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

    • matrix

      public int[][] matrix()
      Returns the value of the matrix record component.
      Returns:
      the value of the matrix record component