Package com.io7m.jtensors.storage.bytebuffered

# Class PVectorByteBufferedFloating2s32<T>

java.lang.Object
com.io7m.jtensors.storage.bytebuffered.PVectorByteBufferedFloating2s32<T>

Type Parameters:
  `T` - A phantom type parameter

All Implemented Interfaces:
  `PVectorReadable2DType<T>`, `VectorReadable2DType`, `PVectorStorageFloating2Type<T>`, `VectorStorageFloating2Type`, `VectorStorageType`, `PVectorByteBufferedFloating2Type<T>`, `TensorByteBufferedType`, `VectorByteBufferedType`

public final class PVectorByteBufferedFloating2s32<T> extends Object implements PVectorByteBufferedFloating2Type<T>

A storage vector.

Storage component type: `float`

Storage component count: `2`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `final ByteBuffer`
  `byteBuffer()`
  `final long`
  `byteOffset()`
  `protected final int`
  `byteOffsetForIndex(int component_index)`
  `protected final int`
  `componentBytes()`
  `protected int`
  `componentCount()`
  `static <T> PVectorByteBufferedFloating2s32<T>`
  `createWithBase(ByteBuffer b, com.io7m.mutable.numbers.core.MutableLongType base, int offset)`
  Return a new vector that is backed by the given byte buffer `b`
  `final int`
  `offset()`
  `void`
  `setX(double x)`
  Set the `x` component.
  `void`
  `setY(double y)`
  Set the `Y` component.
  `final int`
  `sizeBytes()`
  `double`
  `x()`
  `double`
  `y()`

  ### Methods inherited from class java.lang.Object

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

  ### Methods inherited from interface com.io7m.jtensors.storage.api.parameterized.vectors.PVectorStorageFloating2Type

  `setPVector2D, setPVector2F`

  ### Methods inherited from interface com.io7m.jtensors.storage.bytebuffered.TensorByteBufferedType

  `byteBuffer, byteOffset, offset, sizeBytes`

  ### Methods inherited from interface com.io7m.jtensors.storage.api.unparameterized.vectors.VectorStorageFloating2Type

  `setVector2D, setVector2F, setXY`

- ## Method Details

  - ### createWithBase

    public static <T> PVectorByteBufferedFloating2s32<T> createWithBase(ByteBuffer b, com.io7m.mutable.numbers.core.MutableLongType base, int offset)

    Return a new vector that is backed by the given byte buffer `b`

    The data for the instance will be taken from the data at the current value of `base.get() + offset`, each time a field is requested or set.

    No initialization of the data is performed.

    Type Parameters:
      `T` - A phantom type parameter
    Parameters:
      `b` - The byte buffer
      `base` - The base address
      `offset` - A constant offset
    Returns:
      A new buffered vector

  - ### componentCount

    protected int componentCount()

  - ### x

    public double x()
    Specified by:
      `x` in interface `VectorReadable2DType`
    Returns:
      The `x` component

  - ### y

    public double y()
    Specified by:
      `y` in interface `VectorReadable2DType`
    Returns:
      The `y` component

  - ### setX

    public void setX(double x)
    Description copied from interface: `VectorStorageFloating2Type`
    Set the `x` component.
    Specified by:
      `setX` in interface `VectorStorageFloating2Type`
    Parameters:
      `x` - The X component

  - ### setY

    public void setY(double y)
    Description copied from interface: `VectorStorageFloating2Type`
    Set the `Y` component.
    Specified by:
      `setY` in interface `VectorStorageFloating2Type`
    Parameters:
      `y` - The Y component

  - ### componentBytes

    protected final int componentBytes()

  - ### byteBuffer

    public final ByteBuffer byteBuffer()
    Specified by:
      `byteBuffer` in interface `TensorByteBufferedType`
    Returns:
      The byte buffer that backs the tensor

  - ### byteOffset

    public final long byteOffset()
    Specified by:
      `byteOffset` in interface `TensorByteBufferedType`
    Returns:
      The byte offset of the current tensor

  - ### offset

    public final int offset()
    Specified by:
      `offset` in interface `TensorByteBufferedType`
    Returns:
      A constant offset added to `TensorByteBufferedType.byteOffset()`.

  - ### sizeBytes

    public final int sizeBytes()
    Specified by:
      `sizeBytes` in interface `TensorByteBufferedType`
    Returns:
      The size of a single tensor in bytes

  - ### byteOffsetForIndex

    protected final int byteOffsetForIndex(int component_index)