mikera.indexz.GrowableIndex Maven / Gradle / Ivy

Go to download

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

Fast double-precision vector and matrix maths library for Java, supporting N-dimensional numeric arrays.

There is a newer version: 0.67.0

package mikera.indexz;

import mikera.vectorz.util.IntArrays;

/**
 * An index implementation that supports appending, allowing the Index to be enlarged.
 * 
 * @author Mike
 */
public class GrowableIndex extends AIndex {
	private static final long serialVersionUID = 4466899007444582094L;

	private int[] data;
	private int count=0;

	private static final int DEFAULT_INITIAL_CAPACITY=4;

	public GrowableIndex() {
		this(DEFAULT_INITIAL_CAPACITY);
	}
	
	public GrowableIndex(int initialCapacity) {
		data=IntArrays.create(initialCapacity);
	}
	
	public GrowableIndex(int[] values) {
		data=values;
		count=values.length;
	}
	
	/**
	 * Creates a GrowableVector with the specified index values included
	 * @param source
	 * @return
	 */
	public static GrowableIndex create(AIndex source) {
		int n=source.length();
		GrowableIndex g=new GrowableIndex(n);
		source.copyTo(g.data, 0);
		g.count=n;
		return g;
	}
	
	/**
	 * Creates a GrowableVector with the specified index values included
	 * @param source
	 * @return
	 */
	public static GrowableIndex wrap(int[] indexes) {
		return new GrowableIndex(indexes);
	}

	@Override
	public int get(int i) {
		if ((i<0)||(i>=count)) throw new IndexOutOfBoundsException("Index: "+i);
		return data[i];
	}

	@Override
	public int length() {
		return count;
	}

	@Override
	public void set(int i, int value) {
		if ((i<0)||(i>=count)) {
			if (i==count) {
				append(i);
				return;
			}
			throw new IndexOutOfBoundsException("Index: "+i);
		}
		data[i]=value;
	}
	
	@Override
	public void copyTo(int[] array, int offset) {
		System.arraycopy(data, 0, array, offset, count);
	}

	public void append(int i) {
		ensureCapacity(count+1);
		data[count++]=i;
	}
	
	/**
	 * Appends to a growable index, ensuring that the added index is higher than the last index
	 * @param i
	 */
	public void checkedAppend(int i) {
		if ((count>0)&&(data[count-1]>=i)) throw new IllegalArgumentException("Trying to append non-increasing index value: "+i);
		append(i);
	}

	private void ensureCapacity(int capacity) {
		if (data.length>=capacity) return;
		
		int nLen=Math.max(capacity, data.length*2+4);
		int[] ndata=new int[nLen];
		System.arraycopy(data, 0, ndata, 0, count);
		data=ndata;
	}

	@Override
	public int indexPosition(int x) {
		return IntArrays.indexPosition(data, x, 0, count);
	}

	@Override
	public GrowableIndex exactClone() {
		return create(this);
	}

	@Override
	public int last() {
		return data[count-1];
	}

	/**
	 * Includes a value in a distinct, sorted growable index.
	 * @param i
	 * @return The position at which the value is added (or already exists)
	 */
	public int include(int i) {
		int ix=this.seekPosition(i);
		if (ix==count) {
			append(i);
			return ix;
		} else if (data[ix]==i) {
			return ix;
		}
		ensureCapacity(count+1);
		System.arraycopy(data, ix, data, ix+1, count-ix);
		data[ix]=i;
		count++;
		return ix;
	}

	@Override
	public int seekPosition(int i) {
		return IntArrays.seekPosition(data,i,0,count);
	}
}