org.kernelab.basis.VectorAccessible Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of basis Show documentation

Basis Library

There is a newer version: 0.0.19-RELEASE

package org.kernelab.basis;

/**
 * The interface that define the Object which can be accessed as a vector.

 * Similar as object in some script languages, objects can be accessed as
 * {@code o.id} and also can be accessed {@code o["id"]}.

 * Here, object can be accessed as a vector which is indexed by integer.
 * 
 * @author Dilly King
 * 
 */
public interface VectorAccessible
{
	/**
	 * Return the length of the vector.
	 * 
	 * @return The length of the vector.
	 */
	public int vectorAccess();

	/**
	 * Get the value in vector at position of index.
	 * 
	 * @param index
	 *            The position to get the value.
	 * @return The value in vector at index.
	 */
	public Object vectorAccess(int index);

	/**
	 * Set the value in vector at position of index.
	 * 
	 * @param index
	 *            The position to set the value.
	 * @param element
	 *            The value to set.
	 */
	public void vectorAccess(int index, Object element);
}