jruby/docs BETA
org.apache.lucene.util.packed 28
C AbstractPagedMutable
C BlockPackedReaderIterator
C BlockPackedWriter
C Builder
I Decoder
C DirectMonotonicReader
C DirectMonotonicWriter
C DirectReader
C DirectWriter
I Encoder
E Format
R FormatAndBits
C GrowableWriter
C Iterator
C Meta
C MonotonicBlockPackedReader
C MonotonicBlockPackedWriter
C Mutable
C NullReader
C PackedDataInput
C PackedDataOutput
C PackedInts
C PackedLongValues
C PagedGrowableWriter
C PagedMutable
C Reader
I ReaderIterator
C Writer
Format — members 12+
F PACKED() Format
F PACKED_SINGLE_BLOCK() Format
F id() int
M by_id(id) Format
M byte_count(packed_ints_version, value_count, bits_per_value) long
M id() int
M is_supported(bits_per_value) boolean
M long_count(packed_ints_version, value_count, bits_per_value) int
M overhead_per_value(bits_per_value) float
M overhead_ratio(bits_per_value) float
M value_of(name) Format
M values() Format[]
from Enum
M compare_to(arg0) int
M declaring_class() Class<E>
M describe_constable() EnumDesc<E>>
M equals(arg0) boolean
M hash_code() int
M name() String
M ordinal() int
M to_string() String

org.apache.lucene.util.packed.Format

enum 12 members

A format to write packed ints.

Constants

constanttypenote
PACKED PackedInts.Format Compact format, all bits are written contiguously.
PACKED_SINGLE_BLOCK PackedInts.Format 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(int, int, float) to find the format that best suits your needs.

Fields

fieldtypenote
id int

Class Methods

by_id

PackedInts.Format by_id ( int id )
Java: byId(int id)

Get a format according to its ID.

value_of

PackedInts.Format value_of ( String name )
Java: valueOf(String name)

values

PackedInts.Format[] values ( )
Java: values()

Instance Methods

byte_count

long byte_count ( int packed_ints_version, int value_count, int bits_per_value )
Java: byteCount(int packedIntsVersion, int valueCount, int bitsPerValue)

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

id

int id ( )
Java: getId() · also: get_id

Returns the ID of the format.

is_supported

boolean is_supported ( int bits_per_value )
Java: isSupported(int bitsPerValue)

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

long_count

int long_count ( int packed_ints_version, int value_count, int bits_per_value )
Java: longCount(int packedIntsVersion, int valueCount, int bitsPerValue)

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

overhead_per_value

float overhead_per_value ( int bits_per_value )
Java: overheadPerValue(int bitsPerValue)

Returns the overhead per value, in bits.

overhead_ratio

float overhead_ratio ( int bits_per_value )
Java: overheadRatio(int bitsPerValue)

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

Inherited

from Enum

compare_to

int compare_to ( E arg0 )
Java: compareTo(E arg0)

declaring_class

Class<E> declaring_class ( )
Java: getDeclaringClass() · also: get_declaring_class

describe_constable

Optional<Enum.EnumDesc<E>> describe_constable ( )
Java: describeConstable()

equals

boolean equals ( Object arg0 )
Java: equals(Object arg0)

hash_code

int hash_code ( )
Java: hashCode()

name

String name ( )
Java: name()

ordinal

int ordinal ( )
Java: ordinal()

to_string

String to_string ( )
Java: toString()
this work for additional information regarding copyright ownership.