de.lmu.ifi.dbs.elki.database.ids.integer

Class DoubleIntegerDBIDList

java.lang.Object

de.lmu.ifi.dbs.elki.database.ids.integer.DoubleIntegerDBIDList

All Implemented Interfaces:

DBIDs, DoubleDBIDList, IntegerDBIDs, ModifiableDoubleDBIDList

Direct Known Subclasses:

DoubleIntegerDBIDKNNList

 class DoubleIntegerDBIDList
extends Object
implements ModifiableDoubleDBIDList, IntegerDBIDs

Class to store double distance, integer DBID results.

Author:

Erich Schubert

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	DoubleIntegerDBIDList.Itr List iterator.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) double[]	dists Distance values
private static double[]	EMPTY_DISTS Empty.
private static int[]	EMPTY_IDS Empty.
(package private) int[]	ids DBIDs
private static int	INITIAL_SIZE Initial size allocation.
(package private) int	size The size

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DoubleIntegerDBIDList() Constructor.
protected	DoubleIntegerDBIDList(int size) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(DoubleDBIDPair pair) Add an element.
void	add(double dist, DBIDRef id) Add an object to this result.
protected void	addInternal(double dist, int id) Add an entry, consisting of distance and internal index.
void	clear() Clear the list contents.
boolean	contains(DBIDRef o) Test whether an ID is contained.
DoubleIntegerDBIDPair	get(int index) Materialize a single pair.
protected void	grow() Grow the data storage.
boolean	isEmpty() Test for an empty DBID collection.
DoubleIntegerDBIDList.Itr	iter() Get a DBID iterator (a more efficient API).
void	remove(int p) Remove the entry at position p by shifting the remainder forward.
void	removeSwap(int p) Remove the entry at position p by swapping with the last (not preserving the order).
protected void	reverse() Reverse the list.
int	size() Retrieve the collection / data size.
void	sort() Sort the result in ascending order
void	swap(int i, int j) Swap to entries in the list.
String	toString()
void	truncate(int newsize) Truncate the list to the given size, freeing the memory.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

INITIAL_SIZE

private static final int INITIAL_SIZE

Initial size allocation.

See Also:

Constant Field Values

size

int size

The size

dists

double[] dists

Distance values

ids

int[] ids

DBIDs

EMPTY_DISTS

private static final double[] EMPTY_DISTS

Empty.

EMPTY_IDS

private static final int[] EMPTY_IDS

Empty.

Constructor Detail

DoubleIntegerDBIDList

protected DoubleIntegerDBIDList()

Constructor.

DoubleIntegerDBIDList

protected DoubleIntegerDBIDList(int size)

Constructor.

Parameters:

size - Initial size

Method Detail

iter

public DoubleIntegerDBIDList.Itr iter()

Description copied from interface: DBIDs

Get a DBID iterator (a more efficient API). usage example:

 for(DBIDIter iter = ids.iter(); iter.valid(); iter.advance()) {
   DBID id = iter.getDBID();
 }
 
 

Specified by:

iter in interface DBIDs

Specified by:

iter in interface DoubleDBIDList

Specified by:

iter in interface IntegerDBIDs

Specified by:

iter in interface ModifiableDoubleDBIDList

Returns:

iterator

contains

public boolean contains(DBIDRef o)

Description copied from interface: DBIDs

Test whether an ID is contained.

Specified by:

contains in interface DBIDs

Parameters:

o - object to test

Returns:

true when contained

isEmpty

public boolean isEmpty()

Description copied from interface: DBIDs

Test for an empty DBID collection.

Specified by:

isEmpty in interface DBIDs

Returns:

true when empty.

size

public int size()

Description copied from interface: DBIDs

Retrieve the collection / data size.

Specified by:

size in interface DBIDs

Specified by:

size in interface DoubleDBIDList

Returns:

collection size

get

public DoubleIntegerDBIDPair get(int index)

Description copied from interface: DoubleDBIDList

Materialize a single pair.

Specified by:

get in interface DoubleDBIDList

Parameters:

index - Offset

Returns:

Pair

addInternal

protected void addInternal(double dist,
               int id)

Add an entry, consisting of distance and internal index.

Parameters:

dist - Distance

id - Internal index

grow

protected void grow()

Grow the data storage.

add

public void add(double dist,
       DBIDRef id)

Description copied from interface: ModifiableDoubleDBIDList

Add an object to this result.

Specified by:

add in interface ModifiableDoubleDBIDList

Parameters:

dist - Distance to add

id - DBID to add

add

public void add(DoubleDBIDPair pair)

Description copied from interface: ModifiableDoubleDBIDList

Add an element.

Specified by:

add in interface ModifiableDoubleDBIDList

Parameters:

pair - Pair to add

clear

public void clear()

Description copied from interface: ModifiableDoubleDBIDList

Clear the list contents.

Specified by:

clear in interface ModifiableDoubleDBIDList

sort

public void sort()

Description copied from interface: ModifiableDoubleDBIDList

Sort the result in ascending order

Specified by:

sort in interface ModifiableDoubleDBIDList

reverse

protected void reverse()

Reverse the list.

remove

public void remove(int p)

Description copied from interface: ModifiableDoubleDBIDList

Remove the entry at position p by shifting the remainder forward.

Specified by:

remove in interface ModifiableDoubleDBIDList

Parameters:

p - Entry offset to remove

removeSwap

public void removeSwap(int p)

Description copied from interface: ModifiableDoubleDBIDList

Remove the entry at position p by swapping with the last (not preserving the order).

Specified by:

removeSwap in interface ModifiableDoubleDBIDList

Parameters:

p - Entry offset to remove

swap

public void swap(int i,
        int j)

Description copied from interface: ModifiableDoubleDBIDList

Swap to entries in the list.

Specified by:

swap in interface ModifiableDoubleDBIDList

Parameters:

i - First entry

j - Second entry

truncate

public void truncate(int newsize)

Truncate the list to the given size, freeing the memory.

Parameters:

newsize - New size

toString

public String toString()

Overrides:

toString in class Object