Record Class NativeSparseTriplets

java.lang.Object
java.lang.Record
org.wpilib.math.autodiff.NativeSparseTriplets
Record Components:
rows - Triplet rows.
cols - Triplet columns.
values - Triplet values.
public record NativeSparseTriplets(int[] rows, int[] cols, double[] values) extends Record
Wrapper for sparse matrix triplets from JNI.

We can't use DMatrixSparseTriplet because it doesn't have a method for bulk-initialization from triplet arrays.

  • Constructor Summary

    Constructors
    Constructor
    Description
    NativeSparseTriplets(int[] rows, int[] cols, double[] values)
    Creates an instance of a NativeSparseTriplets record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int[]
    cols()
    Returns the value of the cols record component.
    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[]
    rows()
    Returns the value of the rows record component.
    org.ejml.simple.SimpleMatrix
    toSimpleMatrix(int rows, int cols)
    Returns a SimpleMatrix wrapper for this set of triplets.
    final String
    toString()
    Returns a string representation of this record class.
    double[]
    values()
    Returns the value of the values record component.

    Methods inherited from class Object

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

  • Constructor Details

    • NativeSparseTriplets

      public NativeSparseTriplets(int[] rows, int[] cols, double[] values)
      Creates an instance of a NativeSparseTriplets record class.
      Parameters:
      rows - the value for the rows record component
      cols - the value for the cols record component
      values - the value for the values record component

  • Method Details

    • toSimpleMatrix

      public org.ejml.simple.SimpleMatrix toSimpleMatrix(int rows, int cols)
      Returns a SimpleMatrix wrapper for this set of triplets.
      Parameters:
      rows - Number of rows in sparse SimpleMatrix.
      cols - Number of columns in sparse SimpleMatrix.
      Returns:
      A SimpleMatrix wrapper for this set of triplets.

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

    • rows

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

    • cols

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

    • values

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