it.unimi.dsi.util

Class SemiExternalGammaList

java.lang.Object

java.util.AbstractCollection<Long>

it.unimi.dsi.fastutil.longs.AbstractLongCollection

it.unimi.dsi.fastutil.longs.AbstractLongList

it.unimi.dsi.util.SemiExternalGammaList

All Implemented Interfaces:

it.unimi.dsi.fastutil.longs.LongCollection, it.unimi.dsi.fastutil.longs.LongIterable, it.unimi.dsi.fastutil.longs.LongList, it.unimi.dsi.fastutil.longs.LongStack, it.unimi.dsi.fastutil.Stack<Long>, Comparable<List<? extends Long>>, Iterable<Long>, Collection<Long>, List<Long>

public class SemiExternalGammaList
extends it.unimi.dsi.fastutil.longs.AbstractLongList

Provides semi-external random access to a list of γ-encoded integers.

This class is a semi-external LongList that MG4J uses to access files containing frequencies.

Instead, this class accesses frequencies in their compressed forms, and provides entry points for random access to each long. At construction time, entry points are computed with a certain step, which is the number of longs accessible from each entry point, or, equivalently, the maximum number of longs that will be necessary to read to access a given long.

Warning: This class is not thread safe, and needs to be synchronised to be used in a multithreaded environment.

Author:

Fabien Campagne, Sebastiano Vigna

Nested Class Summary

Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.longs.AbstractLongList

it.unimi.dsi.fastutil.longs.AbstractLongList.LongSubList

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_STEP

Constructor Summary

Constructors

Constructor and Description
SemiExternalGammaList(InputBitStream longs) Creates a new semi-external list.
SemiExternalGammaList(InputBitStream longs, int step, int numLongs) Creates a new semi-external list.

Method Summary

Methods

Modifier and Type	Method and Description
long	getLong(int index)
int	size()

Methods inherited from class it.unimi.dsi.fastutil.longs.AbstractLongList

add, add, add, addAll, addAll, addAll, addAll, addAll, addAll, addElements, addElements, compareTo, contains, ensureIndex, ensureRestrictedIndex, equals, get, getElements, hashCode, indexOf, indexOf, iterator, lastIndexOf, lastIndexOf, listIterator, listIterator, longListIterator, longListIterator, longSubList, peek, peekLong, pop, popLong, push, push, rem, remove, remove, removeElements, removeLong, set, set, size, subList, top, topLong, toString

Methods inherited from class it.unimi.dsi.fastutil.longs.AbstractLongCollection

add, contains, containsAll, containsAll, isEmpty, longIterator, rem, removeAll, removeAll, retainAll, retainAll, toArray, toArray, toArray, toLongArray, toLongArray

Methods inherited from class java.util.AbstractCollection

clear

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

add, clear, contains, containsAll, isEmpty, removeAll, retainAll, toArray, toArray

Methods inherited from interface it.unimi.dsi.fastutil.longs.LongCollection

containsAll, longIterator, removeAll, retainAll, toArray, toArray, toLongArray, toLongArray

Methods inherited from interface it.unimi.dsi.fastutil.Stack

isEmpty

Field Detail

DEFAULT_STEP

public static final int DEFAULT_STEP

See Also:

Constant Field Values

Constructor Detail

SemiExternalGammaList

public SemiExternalGammaList(InputBitStream longs,
                     int step,
                     int numLongs)
                      throws IOException

Creates a new semi-external list.

Parameters:

longs - a bit stream containing γ-encoded longs.

step - the step used to build random-access entry points, or -1 to get DEFAULT_STEP.

numLongs - the overall number of offsets (i.e., the number of terms).

Throws:

IOException

SemiExternalGammaList

public SemiExternalGammaList(InputBitStream longs)
                      throws IOException

Creates a new semi-external list.

This quick-and-dirty constructor estimates the number of longs by checking for an EOFException.

Parameters:

longs - a bit stream containing γ-encoded longs.

Throws:

IOException

Method Detail

getLong

public final long getLong(int index)

size

public int size()

Specified by:

size in interface Collection<Long>

Specified by:

size in interface List<Long>

Specified by:

size in class AbstractCollection<Long>