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

Class MaskedDBIDs

java.lang.Object

de.lmu.ifi.dbs.elki.database.ids.generic.MaskedDBIDs

All Implemented Interfaces:

DBIDs

public class MaskedDBIDs
extends Object
implements DBIDs

View on an ArrayDBIDs masked using a BitMask for efficient mask changing.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	MaskedDBIDs.DBIDItr Iterator over set bits.
protected class	MaskedDBIDs.InvDBIDItr Iterator over set bits.

Field Summary

Fields

Modifier and Type	Field and Description
protected BitSet	bits The bitmask used for masking.
protected ArrayDBIDs	data Data storage.
protected boolean	inverse Flag whether to iterator over set or unset values.

Constructor Summary

Constructors

Constructor and Description
MaskedDBIDs(ArrayDBIDs data, BitSet bits, boolean inverse) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(DBIDRef o) Test whether an ID is contained.
boolean	isEmpty() Test for an empty DBID collection.
DBIDIter	iter() Get a DBID iterator (a more efficient API).
int	size() Retrieve the collection / data size.

Methods inherited from class java.lang.Object

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

Field Detail

data

protected ArrayDBIDs data

Data storage.

bits

protected BitSet bits

The bitmask used for masking.

inverse

protected boolean inverse

Flag whether to iterator over set or unset values.

Constructor Detail

MaskedDBIDs

public MaskedDBIDs(ArrayDBIDs data,
           BitSet bits,
           boolean inverse)

Constructor.

Parameters:

data - Data

bits - Bitset to use as mask

inverse - Flag to inverse the masking rule

Method Detail

iter

public DBIDIter 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

Returns:

iterator

size

public int size()

Description copied from interface: DBIDs

Retrieve the collection / data size.

Specified by:

size in interface DBIDs

Returns:

collection size

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.