Class PackedInt32s.Format

A format to write packed s.

This is a Lucene.NET INTERNAL API, use at your own risk

Inheritance

System.Object

PackedInt32s.Format

Namespace: Lucene.Net.Util.Packed

Assembly: Lucene.Net.dll

Syntax

public class Format : object

Fields

| Improve this Doc View Source

PACKED

Compact format, all bits are written contiguously.

Declaration

public static readonly PackedInt32s.Format PACKED

Field Value

Type	Description
PackedInt32s.Format

| Improve this Doc View Source

PACKED_SINGLE_BLOCK

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 FastestFormatAndBits(Int32, Int32, Single) to find the format that best suits your needs.

Declaration

public static readonly PackedInt32s.Format PACKED_SINGLE_BLOCK

Field Value

Type	Description
PackedInt32s.Format

Properties

| Improve this Doc View Source

Id

Returns the ID of the format.

Declaration

public int Id { get; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

Values

Declaration

public static IEnumerable<PackedInt32s.Format> Values { get; }

Property Value

Type	Description
IEnumerable<PackedInt32s.Format>

Methods

| Improve this Doc View Source

ById(Int32)

Get a format according to its ID.

Declaration

public static PackedInt32s.Format ById(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
PackedInt32s.Format

| Improve this Doc View Source

ByteCount(Int32, Int32, Int32)

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

Declaration

public virtual long ByteCount(int packedIntsVersion, int valueCount, int bitsPerValue)

Parameters

Type	Name	Description
System.Int32	packedIntsVersion
System.Int32	valueCount
System.Int32	bitsPerValue

Returns

Type	Description
System.Int64

| Improve this Doc View Source

Int64Count(Int32, Int32, Int32)

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

NOTE: This was longCount() in Lucene.

Declaration

public virtual int Int64Count(int packedIntsVersion, int valueCount, int bitsPerValue)

Parameters

Type	Name	Description
System.Int32	packedIntsVersion
System.Int32	valueCount
System.Int32	bitsPerValue

Returns

Type	Description
System.Int32

| Improve this Doc View Source

IsSupported(Int32)

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

Declaration

public virtual bool IsSupported(int bitsPerValue)

Parameters

Type	Name	Description
System.Int32	bitsPerValue

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

OverheadPerValue(Int32)

Returns the overhead per value, in bits.

Declaration

public virtual float OverheadPerValue(int bitsPerValue)

Parameters

Type	Name	Description
System.Int32	bitsPerValue

Returns

Type	Description
System.Single

| Improve this Doc View Source

OverheadRatio(Int32)

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

Declaration

public virtual float OverheadRatio(int bitsPerValue)

Parameters

Type	Name	Description
System.Int32	bitsPerValue

Returns

Type	Description
System.Single