Package io.deephaven.vector

Interface ByteVector

All Superinterfaces:
Comparable<ByteVector>, Iterable<Byte>, LongSizedDataStructure, Serializable, Vector<ByteVector>
All Known Implementing Classes:
ByteRingBufferVectorWrapper, ByteSegmentedSortedMultiset, ByteSubVector, ByteVector.Indirect, ByteVectorColumnWrapper, ByteVectorDirect, ByteVectorSlice
public interface ByteVector extends Vector<ByteVector>, Iterable<Byte>
A Vector of primitive bytes.

  • Field Details

  • Method Details

    • type

      static PrimitiveVectorType<ByteVector,Byte> type()

    • get

      @UserInvocationPermitted("vector") byte get(long index)
      Get the element of this ByteVector at offset index. If index is not within range [0, size()), will return the null byte.
      Parameters:
      index - An offset into this ByteVector
      Returns:
      The element at the specified offset, or the null byte

    • subVector

      ByteVector subVector(long fromIndexInclusive, long toIndexExclusive)
      Description copied from interface: Vector
      Get a Vector that represents a slice of this Vector.
      Specified by:
      subVector in interface Vector<ByteVector>
      Parameters:
      fromIndexInclusive - The first offset into this Vector to include in the result; if negative, the result will have a range of null values at offsets in [0, -fromIndexInclusive)
      toIndexExclusive - The first offset into this Vector to not include in the result; if larger than size(), the result will have a range of null values at the corresponding offsets
      Returns:
      The sub-Vector specified by [fromIndexInclusive, toIndexExclusive)

    • subVectorByPositions

      ByteVector subVectorByPositions(long[] positions)
      Description copied from interface: Vector
      Get a Vector that represents a set of offset positions in this Vector.
      Specified by:
      subVectorByPositions in interface Vector<ByteVector>
      Parameters:
      positions - The offsets to include; if not within [0, size()), the corresponding offset in the result will contain the appropriate null value
      Returns:
      The sub-Vector specified by positions

    • toArray

      byte[] toArray()
      Description copied from interface: Vector
      Get an array representation of the elements of this Vector. Callers must not mutate the result, as implementations may choose to return their backing array in some cases.
      Specified by:
      toArray in interface Vector<ByteVector>
      Returns:
      An array representation of the elements of this Vector that must not be mutated

    • copyToArray

      byte[] copyToArray()
      Description copied from interface: Vector
      Get an array representation of the elements of this Vector. Callers may freely mutate the result, as it is guaranteed to be freshly-allocated and belongs to the caller upon return.
      Specified by:
      copyToArray in interface Vector<ByteVector>
      Returns:
      An array representation of the elements of this Vector that may be freely mutated

    • getDirect

      ByteVector getDirect()
      Specified by:
      getDirect in interface Vector<ByteVector>
      Returns:
      A version of this Vector that is flattened out to only reference memory

    • iterator

      @UserInvocationPermitted("vector") @FinalDefault default ValueIteratorOfByte iterator()
      Specified by:
      iterator in interface Iterable<Byte>

    • iterator

      default ValueIteratorOfByte iterator(long fromIndexInclusive, long toIndexExclusive)
      Returns an iterator over a slice of this vector, with equivalent semantics to subVector(fromIndexInclusive, toIndexExclusive).iterator().
      Parameters:
      fromIndexInclusive - The first position to include
      toIndexExclusive - The first position after fromIndexInclusive to not include
      Returns:
      An iterator over the requested slice

    • getComponentType

      @FinalDefault default Class<?> getComponentType()
      Specified by:
      getComponentType in interface Vector<ByteVector>
      Returns:
      The type of elements contained by this Vector

    • toString

      @FinalDefault default String toString(int prefixLength)
      Description copied from interface: Vector
      Get a String representation of a prefix of this Vector.
      Specified by:
      toString in interface Vector<ByteVector>
      Parameters:
      prefixLength - The number of elements to include
      Returns:
      The specified prefix String representation

    • compareTo

      default int compareTo(ByteVector o)

      Compare this vector with another vector.

      The vectors are ordered lexicographically using Deephaven sorting rules.

      Specified by:
      compareTo in interface Comparable<ByteVector>

    • byteValToString

      static String byteValToString(Object val)

    • primitiveByteValToString

      static String primitiveByteValToString(byte val)

    • toString

      static String toString(@NotNull @NotNull ByteVector vector, int prefixLength)
      Helper method for implementing Object.toString().
      Parameters:
      vector - The ByteVector to convert to a String
      prefixLength - The maximum prefix of vector to convert
      Returns:
      The String representation of vector

    • equals

      static boolean equals(@NotNull @NotNull ByteVector aVector, @Nullable @Nullable Object bObj)
      Helper method for implementing Object.equals(Object).
      Parameters:
      aVector - The LHS of the equality test (always a ByteVector)
      bObj - The RHS of the equality test
      Returns:
      Whether the two inputs are equal

    • compareTo

      static int compareTo(ByteVector aVector, ByteVector bVector)
      Helper method for Comparable.compareTo(Object) for a generic ByteVector.
      Parameters:
      aVector - the first vector (this in compareTo)
      bVector - the second vector ("o" or other in compareTo)
      Returns:
      -1, 0, or 1 if aVector is less than, equal to, or greater than bVector (respectively)

    • hashCode

      static int hashCode(@NotNull @NotNull ByteVector vector)
      Helper method for implementing Object.hashCode(). Follows the pattern in Arrays.hashCode(byte[]).
      Parameters:
      vector - The ByteVector to hash
      Returns:
      The hash code