xyz.felh.openai.gpt3.tokenizer

Class ByteSequence.Of

java.lang.Object

xyz.felh.openai.gpt3.tokenizer.ByteSequence.Of

All Implemented Interfaces:

java.lang.Comparable<ByteSequence.Of>, ByteSequence

Enclosing interface:

ByteSequence

public static final class ByteSequence.Of
extends java.lang.Object
implements ByteSequence, java.lang.Comparable<ByteSequence.Of>

An immutable implementation of the ByteSequence.

Nested Class Summary

Nested classes/interfaces inherited from interface xyz.felh.openai.gpt3.tokenizer.ByteSequence

ByteSequence.Of

Field Summary

Fields inherited from interface xyz.felh.openai.gpt3.tokenizer.ByteSequence

EMPTY

Method Summary

Modifier and Type	Method and Description
byte	byteAt(int index) Returns the byte at the specified offset.
int	compareTo(ByteSequence.Of other)
boolean	equals(java.lang.Object obj) Compares the specified object with this byte sequence for equality.
int	hashCode() Returns a hash code value for this byte sequence.
int	length() Returns the length of the byte sequence.
ByteSequence.Of	subSequence(int start, int end) Returns a new ByteSequence that is a sub-sequence of the current byte sequence.
byte[]	toByteArray() Returns a byte array representation of this byte sequence.
java.lang.String	toString()
java.lang.String	toString(java.nio.charset.Charset charset) Converts the byte sequence to a String using the specified Charset.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface xyz.felh.openai.gpt3.tokenizer.ByteSequence

copyOf, from, from, of

Method Detail

byteAt

public byte byteAt(int index)

Description copied from interface: ByteSequence

Returns the byte at the specified offset.

Specified by:

byteAt in interface ByteSequence

Parameters:

index - the zero-based byte offset within the sequence of bytes (0 <= index < length())

Returns:

the byte at the specified offset

length

public int length()

Description copied from interface: ByteSequence

Returns the length of the byte sequence.

Specified by:

length in interface ByteSequence

Returns:

the number of bytes in the sequence

subSequence

public ByteSequence.Of subSequence(int start,
                                   int end)

Description copied from interface: ByteSequence

Returns a new ByteSequence that is a sub-sequence of the current byte sequence. The sub-sequence starts with the byte value at the specified start index and extends to the byte value at index end - 1.

Specified by:

subSequence in interface ByteSequence

Parameters:

start - the beginning index, inclusive

end - the ending index, exclusive

Returns:

a new ByteSequence that is a sub-sequence of this byte sequence

hashCode

public int hashCode()

Description copied from interface: ByteSequence

Returns a hash code value for this byte sequence.

Specified by:

hashCode in interface ByteSequence

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code value for this byte sequence

equals

public boolean equals(java.lang.Object obj)

Description copied from interface: ByteSequence

Compares the specified object with this byte sequence for equality. Returns true if and only if the specified object is also a byte sequence and both byte sequences have the same bytes in the same order.

Specified by:

equals in interface ByteSequence

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object to be compared for equality with this byte sequence

Returns:

true if the specified object is equal to this byte sequence, false otherwise

toByteArray

public byte[] toByteArray()

Description copied from interface: ByteSequence

Returns a byte array representation of this byte sequence. The returned array will be a copy of the internal byte array, ensuring that modifications to the returned array do not affect the original byte sequence.

Specified by:

toByteArray in interface ByteSequence

Returns:

a byte array representation of this byte sequence

toString

public java.lang.String toString(java.nio.charset.Charset charset)

Description copied from interface: ByteSequence

Converts the byte sequence to a String using the specified Charset.

Specified by:

toString in interface ByteSequence

Parameters:

charset - the Charset to be used for the conversion

Returns:

a String representation of this byte sequence using the specified Charset

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(ByteSequence.Of other)

Specified by:

compareTo in interface java.lang.Comparable<ByteSequence.Of>