jtransforms 1.0.0

class: FloatLargeArray

[125:14] (extern: com.lehman.aussom.AussomFloatLargeArray) extends: object

Wrapper around a JLargeArrays FloatLargeArray. Used by every JTransforms "Large" overload that takes a FloatLargeArray. Backed by pl.edu.icm.jlargearrays.FloatLargeArray.

Methods

• FloatLargeArray (int Length = 0)

  Constructs a new FloatLargeArray of the given length filled with zeros. The default constructor with no args creates an uninitialized wrapper used by helpers that need to return a populated FloatLargeArray.

  • @p Length is the array length. Default is 0 (uninitialized).

• init (int Length)

• initConstant (int Length, double Constant)

  Constructs a new FloatLargeArray of the given length filled with the supplied constant value.

  • @p Length is a long with the array length.
  • @p Constant is the float fill value.
  • @r This object.

• fromList (list Values)

  Replaces the contents of this FloatLargeArray with the values from an Aussom list. The array is resized to match the list length.

  • @p Values is a list of numbers.
  • @r This object.

• length ()

  Returns the array length.

  • @r A long with the array length.

• getFloat (int Index)

  Returns the value at the given index.

  • @p Index is a long index.
  • @r A double with the value (single precision is widened to double).

• setFloat (int Index, double Value)

  Sets the value at the given index.

  • @p Index is a long index.
  • @p Value is the float value to set (passed as double, narrowed inside).
  • @r This object.

• fill (double Value)

  Fills the entire array with a constant value.

  • @p Value is the float fill value.
  • @r This object.

• toList ()

  Returns the entire array contents as an Aussom list. Beware of memory pressure on very large arrays.

  • @r A list of doubles.

• toListRange (int Start, int End)

  Returns a sub-range of the array as an Aussom list.

  • @p Start is the inclusive start index.
  • @p End is the exclusive end index.
  • @r A list of doubles in the requested range.

• copy ()

  Returns a deep copy of this FloatLargeArray.

  • @r A new FloatLargeArray with copied data.

• equalsTo (object Other)

  Compares this FloatLargeArray to another for equality.

  • @p Other is another FloatLargeArray.
  • @r A bool with true when the two are equal in length and contents.

class: DoubleLargeArray

[26:14] (extern: com.lehman.aussom.AussomDoubleLargeArray) extends: object

Wrapper around a JLargeArrays DoubleLargeArray. Used by every JTransforms "Large" overload that takes a DoubleLargeArray. Backed by pl.edu.icm.jlargearrays.DoubleLargeArray. A DoubleLargeArray can hold up to 2^63 elements, so prefer toListRange() over toList() when working with very large data.

Methods

• DoubleLargeArray (int Length = 0)

  Constructs a new DoubleLargeArray of the given length filled with zeros. The default constructor with no args creates an uninitialized wrapper, which is used internally when other helpers (for example IOUtils.fillMatrix1DLargeD) need to return a populated DoubleLargeArray.

  • @p Length is the array length. Default is 0 (uninitialized).

• init (int Length)

• initConstant (int Length, double Constant)

  Constructs a new DoubleLargeArray of the given length filled with the supplied constant value.

  • @p Length is a long with the array length.
  • @p Constant is the double fill value.
  • @r This object.

• fromList (list Values)

  Replaces the contents of this DoubleLargeArray with the values from an Aussom list. The array is resized to match the list length.

  • @p Values is a list of numbers.
  • @r This object.

• length ()

  Returns the array length.

  • @r A long with the array length.

• getDouble (int Index)

  Returns the value at the given index.

  • @p Index is a long index.
  • @r A double with the value.

• setDouble (int Index, double Value)

  Sets the value at the given index.

  • @p Index is a long index.
  • @p Value is the double value to set.
  • @r This object.

• fill (double Value)

  Fills the entire array with a constant value.

  • @p Value is the double fill value.
  • @r This object.

• toList ()

  Returns the entire array contents as an Aussom list. Beware of memory pressure on very large arrays. Prefer toListRange for sampling.

  • @r A list of doubles.

• toListRange (int Start, int End)

  Returns a sub-range of the array as an Aussom list.

  • @p Start is the inclusive start index.
  • @p End is the exclusive end index.
  • @r A list of doubles in the requested range.

• copy ()

  Returns a deep copy of this DoubleLargeArray.

  • @r A new DoubleLargeArray with copied data.

• equalsTo (object Other)

  Compares this DoubleLargeArray to another for equality.

  • @p Other is another DoubleLargeArray.
  • @r A bool with true when the two are equal in length and contents.