Class Float4Vector

All Implemented Interfaces:
Closeable, AutoCloseable, Iterable<ValueVector>, ElementAddressableVector, FieldVector, FixedWidthVector, FloatingPointVector, ValueIterableVector<Float>, ValueVector, VectorDefinitionSetter

public final class Float4Vector extends BaseFixedWidthVector implements FloatingPointVector, ValueIterableVector<Float>
Float4Vector implements a fixed width vector (4 bytes) of float values which could be null. A validity buffer (bit vector) is maintained to track which elements in the vector are null.
  • Field Details

  • Constructor Details

    • Float4Vector

      public Float4Vector(String name, BufferAllocator allocator)
      Instantiate a Float4Vector. This doesn't allocate any memory for the data in vector.
      Parameters:
      name - name of the vector
      allocator - allocator for memory management.
    • Float4Vector

      public Float4Vector(String name, FieldType fieldType, BufferAllocator allocator)
      Instantiate a Float4Vector. This doesn't allocate any memory for the data in vector.
      Parameters:
      name - name of the vector
      fieldType - type of Field materialized by this vector
      allocator - allocator for memory management.
    • Float4Vector

      public Float4Vector(Field field, BufferAllocator allocator)
      Instantiate a Float4Vector. This doesn't allocate any memory for the data in vector.
      Parameters:
      field - field materialized by this vector
      allocator - allocator for memory management.
  • Method Details

    • getReaderImpl

      protected FieldReader getReaderImpl()
      Description copied from class: BaseValueVector
      Each vector has a different reader that implements the FieldReader interface. Overridden methods must make sure to return the correct concrete reader implementation.
      Specified by:
      getReaderImpl in class BaseValueVector
      Returns:
      Returns a lambda that initializes a reader when called.
    • getMinorType

      public Types.MinorType getMinorType()
      Get minor type for this vector. The vector holds values belonging to a particular type.
      Specified by:
      getMinorType in interface ValueVector
      Returns:
      Types.MinorType
    • get

      public float get(int index) throws IllegalStateException
      Get the element at the given index from the vector.
      Parameters:
      index - position of element
      Returns:
      element at given index
      Throws:
      IllegalStateException
    • get

      public void get(int index, NullableFloat4Holder holder)
      Get the element at the given index from the vector and sets the state in holder. If element at given index is null, holder.isSet will be zero.
      Parameters:
      index - position of element
    • getObject

      public Float getObject(int index)
      Same as get(int).
      Specified by:
      getObject in interface ValueVector
      Parameters:
      index - position of element
      Returns:
      element at given index
    • set

      public void set(int index, float value)
      Set the element at the given index to the given value.
      Parameters:
      index - position of element
      value - value of element
    • set

      public void set(int index, NullableFloat4Holder holder) throws IllegalArgumentException
      Set the element at the given index to the value set in data holder. If the value in holder is not indicated as set, element in the at the given index will be null.
      Parameters:
      index - position of element
      holder - nullable data holder for value of element
      Throws:
      IllegalArgumentException
    • set

      public void set(int index, Float4Holder holder)
      Set the element at the given index to the value set in data holder.
      Parameters:
      index - position of element
      holder - data holder for value of element
    • setSafe

      public void setSafe(int index, float value)
      Same as set(int, float) except that it handles the case when index is greater than or equal to existing value capacity BaseFixedWidthVector.getValueCapacity().
      Parameters:
      index - position of element
      value - value of element
    • setSafe

      public void setSafe(int index, NullableFloat4Holder holder) throws IllegalArgumentException
      Same as set(int, NullableFloat4Holder) except that it handles the case when index is greater than or equal to existing value capacity BaseFixedWidthVector.getValueCapacity().
      Parameters:
      index - position of element
      holder - nullable data holder for value of element
      Throws:
      IllegalArgumentException
    • setSafe

      public void setSafe(int index, Float4Holder holder)
      Same as set(int, Float4Holder) except that it handles the case when index is greater than or equal to existing value capacity BaseFixedWidthVector.getValueCapacity().
      Parameters:
      index - position of element
      holder - data holder for value of element
    • set

      public void set(int index, int isSet, float value)
      Store the given value at a particular position in the vector. isSet indicates whether the value is NULL or not.
      Parameters:
      index - position of the new value
      isSet - 0 for NULL value, 1 otherwise
      value - element value
    • setSafe

      public void setSafe(int index, int isSet, float value)
      Same as set(int, int, float) except that it handles the case when index is greater than or equal to current value capacity of the vector.
      Parameters:
      index - position of the new value
      isSet - 0 for NULL value, 1 otherwise
      value - element value
    • get

      public static float get(ArrowBuf buffer, int index)
      Given a data buffer, get the value stored at a particular position in the vector.

      This method should not be used externally.

      Parameters:
      buffer - data buffer
      index - position of the element.
      Returns:
      value stored at the index.
    • setWithPossibleTruncate

      public void setWithPossibleTruncate(int index, double value)
      Description copied from interface: FloatingPointVector
      Sets the value at the given index, note this value may be truncated internally.
      Specified by:
      setWithPossibleTruncate in interface FloatingPointVector
      Parameters:
      index - the index to set.
      value - the value to set.
    • setSafeWithPossibleTruncate

      public void setSafeWithPossibleTruncate(int index, double value)
      Description copied from interface: FloatingPointVector
      Sets the value at the given index, note this value may be truncated internally. Any expansion/reallocation is handled automatically.
      Specified by:
      setSafeWithPossibleTruncate in interface FloatingPointVector
      Parameters:
      index - the index to set.
      value - the value to set.
    • getValueAsDouble

      public double getValueAsDouble(int index)
      Description copied from interface: FloatingPointVector
      Gets the value at the given index.
      Specified by:
      getValueAsDouble in interface FloatingPointVector
      Parameters:
      index - the index to retrieve the value.
      Returns:
      the value at the index.
    • getTransferPair

      public TransferPair getTransferPair(String ref, BufferAllocator allocator)
      Construct a TransferPair comprising this and a target vector of the same type.
      Specified by:
      getTransferPair in interface ValueVector
      Specified by:
      getTransferPair in class BaseFixedWidthVector
      Parameters:
      ref - name of the target vector
      allocator - allocator for the target vector
      Returns:
      TransferPair
    • getTransferPair

      public TransferPair getTransferPair(Field field, BufferAllocator allocator)
      Construct a TransferPair comprising this and a target vector of the same type.
      Specified by:
      getTransferPair in interface ValueVector
      Specified by:
      getTransferPair in class BaseFixedWidthVector
      Parameters:
      field - Field object used by the target vector
      allocator - allocator for the target vector
      Returns:
      TransferPair
    • makeTransferPair

      public TransferPair makeTransferPair(ValueVector to)
      Construct a TransferPair with a desired target vector of the same type.
      Specified by:
      makeTransferPair in interface ValueVector
      Parameters:
      to - target vector
      Returns:
      TransferPair