elki.database.datastore.package-info 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!

/**
 * General data store layer API (along the lines of
 * {@code Map} - use everywhere!) for ELKI.
 * 
 * 
When to use:
 * 
 * Every time you need to associate a larger number of objects (in form of
 * {@link elki.database.ids.DBID DBID}s) with any kind of value.
 * This can be temporary values such as KNN lists, but also result values such
 * as outlier scores.
 * 

 * Basically, {@code DataStore == Map}. But this API will allow
 * extensions that can do on-disk maps.
 * 

 * 
How to use:
 * {@code
 * // Storage for the outlier score of each ID. 
 * final WritableDoubleDataStore scores = DataStoreFactory.FACTORY.makeDoubleStorage(ids, DataStoreFactory.HINT_STATIC);
 * }
 * 
 * @opt hide datastore.memory
 * @opt hide index.preprocessed
 */
/*
 * 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.datastore;