edu.mines.jtk.opt.VectContainer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of edu-mines-jtk Show documentation
Java packages for science and engineering
The newest version!
/****************************************************************************
Copyright 2003, Landmark Graphics and others.
Licensed 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 edu.mines.jtk.opt;

/**
 * Treat an indexed collection of Vects as a new Vect.
 * Defined as an interface to allow both in-memory and cached
 * implementations.
 *
 * @author W.S. Harlan
 */
public interface VectContainer extends Vect {

    /**
     * Save a vect for the specified index.
     *
     * @param index A unique integer for the requested vect.
     *              Integers need not be consecutive.  Use any valid integer.
     * @param vect  Vect for specified index.
     */
    void put(int index, Vect vect);

    /**
     * Get a vect for the specified index.
     *
     * @param index A unique integer for the requested vect.
     *              Integers need not be consecutive.
     * @return Vect associated with this index, or null if none.
     */
    Vect get(int index);

    /**
     * Returns the number of unique indices in this container.
     *
     * @return number of unique indices
     */
    int size();

    /**
     * Returns true if this container has a vect for the specified index.
     *
     * @param index Check for a Vect with this index.
     * @return True if index has been assigned to a vect.
     */
    boolean containsKey(int index);

    /**
     * Return a set of all indices that have been assigned to a value.
     *
     * @return all indices that have been assigned Vect.
     *         Return in the order of preferred access.
     */
    int[] getKeys();

    // Override Object return type
    @Override
    VectContainer clone();
}