elki.database.ids.DBIDRange Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of elki-core-dbids Show documentation

ELKI - Core DBIDs API – Open-Source Data-Mining Framework with Index Acceleration

The newest version!

/*
 * This file is part of ELKI:
 * Environment for Developing KDD-Applications Supported by Index-Structures
 *
 * Copyright (C) 2022
 * ELKI Development Team
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see .
 */
package elki.database.ids;

import elki.database.datastore.DataStoreIDMap;

/**
 * Static DBID range.
 *
 * @author Erich Schubert
 * @since 0.4.0
 */
public interface DBIDRange extends ArrayStaticDBIDs, DataStoreIDMap {
  /**
   * Get offset in the array for a particular DBID.
   * 
   * Should satisfy {@code range.get(getOffset(id)) == id} and
   * {@code range.getOffset(range.get(idx)) == idx}.
   *
   * @param dbid ID to compute index for
   * @return index
   */
  int getOffset(DBIDRef dbid);
}