Package org.ejml.data

Class FMatrix2

java.lang.Object
org.ejml.data.FMatrix2
All Implemented Interfaces:
Serializable, FMatrix, FMatrixFixed, Matrix

@Generated("org.ejml.data.GenerateMatrixFixedN") public class FMatrix2 extends Object implements FMatrixFixed
Fixed sized vector with 2 elements. Can represent a 2 x 1 or 1 x 2 matrix, context dependent.

DO NOT MODIFY. Automatically generated code created by GenerateMatrixFixedN

See Also:
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    float
     
    float
     
  • Constructor Summary

    Constructors
    Constructor
    Description
     
    FMatrix2(float a1, float a2)
     
     
  • Method Summary

    Modifier and Type
    Method
    Description
    <T extends Matrix>
    T
    Creates an exact copy of the matrix
    <T extends Matrix>
    T
    Creates a new matrix with the same shape as this matrix
    float
    get(int row, int col)
    Returns the value of value of the specified matrix element.
    int
    Returns the number of columns in this matrix.
    int
    Returns the number of elements in this matrix, which is the number of rows times the number of columns.
    int
    Returns the number of rows in this matrix.
    Returns the type of matrix
    void
    Prints the matrix to standard out using standard formatting.
    void
    print(String format)
    Prints the matrix to standard out with the specified formatting.
    void
    set(int row, int col, float val)
    Sets the value of the specified matrix element.
    void
    setTo(float a1, float a2)
     
    void
    setTo(int offset, float[] array)
     
    void
    setTo(Matrix original)
    Sets this matrix to be identical to the 'original' matrix passed in.
    float
    unsafe_get(int row, int col)
    Same as FMatrix.get(int, int) but does not perform bounds check on input parameters.
    void
    unsafe_set(int row, int col, float val)
    Same as Matrix.setTo(org.ejml.data.Matrix) but does not perform bounds check on input parameters.
    void
    Sets all values inside the matrix to zero

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.ejml.data.FMatrixFixed

    create
  • Field Details

    • a1

      public float a1
    • a2

      public float a2
  • Constructor Details

    • FMatrix2

      public FMatrix2()
    • FMatrix2

      public FMatrix2(float a1, float a2)
    • FMatrix2

      public FMatrix2(FMatrix2 o)
  • Method Details

    • zero

      public void zero()
      Description copied from interface: Matrix
      Sets all values inside the matrix to zero
      Specified by:
      zero in interface Matrix
    • setTo

      public void setTo(float a1, float a2)
    • setTo

      public void setTo(int offset, float[] array)
    • get

      public float get(int row, int col)
      Description copied from interface: FMatrix
      Returns the value of value of the specified matrix element.
      Specified by:
      get in interface FMatrix
      Parameters:
      row - Matrix element's row index..
      col - Matrix element's column index.
      Returns:
      The specified element's value.
    • unsafe_get

      public float unsafe_get(int row, int col)
      Description copied from interface: FMatrix
      Same as FMatrix.get(int, int) but does not perform bounds check on input parameters. This results in about a 25% speed increase but potentially sacrifices stability and makes it more difficult to track down simple errors. It is not recommended that this function be used, except in highly optimized code where the bounds are implicitly being checked.
      Specified by:
      unsafe_get in interface FMatrix
      Parameters:
      row - Matrix element's row index..
      col - Matrix element's column index.
      Returns:
      The specified element's value.
    • set

      public void set(int row, int col, float val)
      Description copied from interface: FMatrix
      Sets the value of the specified matrix element.
      Specified by:
      set in interface FMatrix
      Parameters:
      row - Matrix element's row index..
      col - Matrix element's column index.
      val - The element's new value.
    • unsafe_set

      public void unsafe_set(int row, int col, float val)
      Description copied from interface: FMatrix
      Same as Matrix.setTo(org.ejml.data.Matrix) but does not perform bounds check on input parameters. This results in about a 25% speed increase but potentially sacrifices stability and makes it more difficult to track down simple errors. It is not recommended that this function be used, except in highly optimized code where the bounds are implicitly being checked.
      Specified by:
      unsafe_set in interface FMatrix
      Parameters:
      row - Matrix element's row index..
      col - Matrix element's column index.
      val - The element's new value.
    • setTo

      public void setTo(Matrix original)
      Description copied from interface: Matrix
      Sets this matrix to be identical to the 'original' matrix passed in.
      Specified by:
      setTo in interface Matrix
    • getNumRows

      public int getNumRows()
      Description copied from interface: Matrix
      Returns the number of rows in this matrix.
      Specified by:
      getNumRows in interface Matrix
      Returns:
      Number of rows.
    • getNumCols

      public int getNumCols()
      Description copied from interface: Matrix
      Returns the number of columns in this matrix.
      Specified by:
      getNumCols in interface Matrix
      Returns:
      Number of columns.
    • getNumElements

      public int getNumElements()
      Description copied from interface: FMatrix
      Returns the number of elements in this matrix, which is the number of rows times the number of columns.
      Specified by:
      getNumElements in interface FMatrix
      Returns:
      Number of elements in this matrix.
    • copy

      public <T extends Matrix> T copy()
      Description copied from interface: Matrix
      Creates an exact copy of the matrix
      Specified by:
      copy in interface Matrix
    • print

      public void print()
      Description copied from interface: Matrix
      Prints the matrix to standard out using standard formatting. This is the same as calling print("%e")
      Specified by:
      print in interface Matrix
    • print

      public void print(String format)
      Description copied from interface: Matrix
      Prints the matrix to standard out with the specified formatting.
      Specified by:
      print in interface Matrix
      Parameters:
      format - printf style formatting for a float. E.g. "%f"
      See Also:
    • createLike

      public <T extends Matrix> T createLike()
      Description copied from interface: Matrix
      Creates a new matrix with the same shape as this matrix
      Specified by:
      createLike in interface Matrix
    • getType

      public MatrixType getType()
      Description copied from interface: Matrix
      Returns the type of matrix
      Specified by:
      getType in interface Matrix