Package io.deephaven.vector

Interface CharVector

All Superinterfaces:
Iterable<Character>, io.deephaven.util.datastructures.LongSizedDataStructure, Serializable, Vector<CharVector>
All Known Implementing Classes:
CharSubVector, CharVector.Indirect, CharVectorDirect, CharVectorSlice
public interface CharVector extends Vector<CharVector>, Iterable<Character>
A Vector of primitive chars.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    CharVector.Indirect
    Base class for all "indirect" CharVector implementations.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final long
    serialVersionUID
     

    Fields inherited from interface io.deephaven.vector.Vector

    NULL_ELEMENT_STRING

  • Method Summary

    Modifier and Type
    Method
    Description
    static String
    charValToString(Object val)
     
    char[]
    copyToArray()
    Get an array representation of the elements of this Vector.
    static boolean
    equals(@NotNull CharVector aVector, @Nullable Object bObj)
    Helper method for implementing Object.equals(Object).
    char
    get(long index)
    Get the element of this CharVector at offset index.
    default Class<?>
    getComponentType()
     
    CharVector
    getDirect()
     
    static int
    hashCode(@NotNull CharVector vector)
    Helper method for implementing Object.hashCode().
    default io.deephaven.engine.primitive.iterator.CloseablePrimitiveIteratorOfChar
    iterator()
     
    default io.deephaven.engine.primitive.iterator.CloseablePrimitiveIteratorOfChar
    iterator(long fromIndexInclusive, long toIndexExclusive)
    Returns an iterator over a slice of this vector, with equivalent semantics to subVector(fromIndexInclusive, toIndexExclusive).iterator().
    static String
    primitiveCharValToString(char val)
     
    CharVector
    subVector(long fromIndexInclusive, long toIndexExclusive)
    Get a Vector that represents a slice of this Vector.
    CharVector
    subVectorByPositions(long[] positions)
    Get a Vector that represents a set of offset positions in this Vector.
    char[]
    toArray()
    Get an array representation of the elements of this Vector.
    default String
    toString(int prefixLength)
    Get a String representation of a prefix of this Vector.
    static String
    toString(@NotNull CharVector vector, int prefixLength)
    Helper method for implementing Object.toString().
    static io.deephaven.qst.type.PrimitiveVectorType<CharVector,Character>
    type()
     

    Methods inherited from interface java.lang.Iterable

    forEach, spliterator

    Methods inherited from interface io.deephaven.util.datastructures.LongSizedDataStructure

    intSize, intSize, size

    Methods inherited from interface io.deephaven.vector.Vector

    isEmpty

  • Field Details

  • Method Details

    • type

      static io.deephaven.qst.type.PrimitiveVectorType<CharVector,Character> type()

    • get

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

    • subVector

      CharVector 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<CharVector>
      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

      CharVector 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<CharVector>
      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

      char[] 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<CharVector>
      Returns:
      An array representation of the elements of this Vector that must not be mutated

    • copyToArray

      char[] 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<CharVector>
      Returns:
      An array representation of the elements of this Vector that may be freely mutated

    • getDirect

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

    • iterator

      @FinalDefault default io.deephaven.engine.primitive.iterator.CloseablePrimitiveIteratorOfChar iterator()
      Specified by:
      iterator in interface Iterable<Character>

    • iterator

      default io.deephaven.engine.primitive.iterator.CloseablePrimitiveIteratorOfChar 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<CharVector>
      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<CharVector>
      Parameters:
      prefixLength - The number of elements to include
      Returns:
      The specified prefix String representation

    • charValToString

      static String charValToString(Object val)

    • primitiveCharValToString

      static String primitiveCharValToString(char val)

    • toString

      static String toString(@NotNull @NotNull CharVector vector, int prefixLength)
      Helper method for implementing Object.toString().
      Parameters:
      vector - The CharVector 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 CharVector aVector, @Nullable @Nullable Object bObj)
      Helper method for implementing Object.equals(Object).
      Parameters:
      aVector - The LHS of the equality test (always a CharVector)
      bObj - The RHS of the equality test
      Returns:
      Whether the two inputs are equal

    • hashCode

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