lucene/core/src/java/org/apache/lucene/index/RandomAccessVectorValuesProducer.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.lucene.index;

/**
 * Something (generally a {@link VectorValues}) that provides a {@link RandomAccessVectorValues}.
 *
 * @lucene.experimental
 */
public interface RandomAccessVectorValuesProducer {
  /**
   * Return a random access interface over this iterator's vectors. Calling the RandomAccess methods
   * will have no effect on the progress of the iteration or the values returned by this iterator.
   * Successive calls will retrieve independent copies that do not overwrite each others' returned
   * values.
   */
  RandomAccessVectorValues randomAccess();
}