core/org.gnit.lucenekmp.util.packed/PackedInts/Format

Format

A format to write packed ints.

Entries

Compact format, all bits are written contiguously.

A format that may insert padding bits to improve encoding and decoding speed. Since this format doesn't support all possible bits per value, you should never use it directly, but rather use PackedInts.fastestFormatAndBits to find the format that best suits your needs.

Types

Companion

object Companion

Properties

entries

val entries: EnumEntries<PackedInts.Format>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

val id: Int

Returns the ID of the format.

name

expect val name: String

ordinal

expect val ordinal: Int

Functions

byteCount

open fun byteCount(packedIntsVersion: Int, valueCount: Int, bitsPerValue: Int): Long

Computes how many byte blocks are needed to store values values of size bitsPerValue.

isSupported

open fun isSupported(bitsPerValue: Int): Boolean

Tests whether the provided number of bits per value is supported by the format.

longCount

open fun longCount(packedIntsVersion: Int, valueCount: Int, bitsPerValue: Int): Int

Computes how many long blocks are needed to store values values of size bitsPerValue.

overheadPerValue

open fun overheadPerValue(bitsPerValue: Int): Float

Returns the overhead per value, in bits.

overheadRatio

fun overheadRatio(bitsPerValue: Int): Float

Returns the overhead ratio (overhead per value / bits per value).

valueOf

fun valueOf(value: String): PackedInts.Format

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<PackedInts.Format>

Returns an array containing the constants of this enum type, in the order they're declared.