package de.lmu.ifi.dbs.elki.database.ids;

/*
 This file is part of ELKI:
 Environment for Developing KDD-Applications Supported by Index-Structures

 Copyright (C) 2015
 Ludwig-Maximilians-Universität München
 Lehr- und Forschungseinheit für Datenbanksysteme
 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 <http://www.gnu.org/licenses/>.
 */

/**
 * Interface for a generic modifiable DBID collection.
 * 
 * Note: we had this use the Java Collections API for a long time, however this
 * prevented certain optimizations. So it now only mimics the Collections API
 * <em>deliberately</em>.
 * 
 * @author Erich Schubert
 * 
 * @apiviz.has DBIDMIter
 */
public interface ModifiableDBIDs extends DBIDs {
  /**
   * Add DBIDs to collection.
   * 
   * @param ids IDs to add.
   * @return {@code true} when modified
   */
  boolean addDBIDs(DBIDs ids);

  /**
   * Remove DBIDs from collection.
   * 
   * @param ids IDs to remove.
   * @return {@code true} when modified
   */
  boolean removeDBIDs(DBIDs ids);

  /**
   * Add a single DBID to the collection.
   * 
   * @param id ID to add
   */
  boolean add(DBIDRef id);

  /**
   * Remove a single DBID from the collection.
   * 
   * @param id ID to remove
   */
  boolean remove(DBIDRef id);

  /**
   * Clear this collection.
   */
  void clear();

  /**
   * Get a <em>modifiable</em> DBID iterator (a more efficient API).
   * 
   * usage example:
   * 
   * <pre>
   * {@code
   * for(DBIDMIter iter = ids.iter(); iter.valid(); iter.advance()) {
   *   DBID id = iter.getDBID();
   *   iter.remove();
   * }
   * }
   * </pre>
   * 
   * @return modifiable iterator
   */
  @Override
  DBIDMIter iter();

  /**
   * Pop (get and remove) one DBID from the set, into a variable.
   *
   * @param outvar Output variable
   */
  void pop(DBIDVar outvar);
}
@@ -986,18 +986,17 @@
 tion.%0A *
- 
 %0A
+
  * Note:
@@ -1173,17 +1173,16 @@
 /em%3E.%0A *
- 
 %0A * @aut
@@ -1202,17 +1202,16 @@
 ubert%0A *
- 
 %0A * @api
@@ -1313,33 +1313,32 @@
 collection.%0A   *
- 
 %0A   * @param ids
@@ -1372,37 +1372,50 @@
 @code true%7D 
-when modifi
+if the collection chang
 ed
+.
 %0A   */%0A  boo
@@ -1478,33 +1478,32 @@
 collection.%0A   *
- 
 %0A   * @param ids
@@ -1548,21 +1548,34 @@
 ue%7D 
-when modifi
+if the collection chang
 ed
+.
 %0A   
@@ -1656,33 +1656,32 @@
 collection.%0A   *
- 
 %0A   * @param id 
@@ -1690,16 +1690,69 @@
  to add%0A
+   * @return %7B@code true%7D if the collection changed.%0A
    */%0A  
@@ -1830,25 +1830,24 @@
 ection.%0A   *
- 
 %0A   * @param
@@ -1863,16 +1863,69 @@
  remove%0A
+   * @return %7B@code true%7D if the collection changed.%0A
    */%0A  
@@ -2085,25 +2085,24 @@
 t API).%0A   *
- 
 %0A   * usage 
@@ -2110,25 +2110,24 @@
 xample:%0A   *
- 
 %0A   * %3Cpre%3E%0A
@@ -2289,21 +2289,20 @@
  %3C/pre%3E%0A
+
    *
- 
 %0A   * @r

Document return values.