org.scijava.util.FloatArray Maven / Gradle / Ivy

/*
 * #%L
 * SciJava Common shared library for SciJava software.
 * %%
 * Copyright (C) 2009 - 2017 Board of Regents of the University of
 * Wisconsin-Madison, Broad Institute of MIT and Harvard, Max Planck
 * Institute of Molecular Cell Biology and Genetics, University of
 * Konstanz, and KNIME GmbH.
 * %%
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 * #L%
 */

package org.scijava.util;

import java.util.Collection;

/**
 * An extensible array of {@code float} elements.
 * 
 * @author Johannes Schindelin
 * @author Curtis Rueden
 */
public class FloatArray extends AbstractPrimitiveArray {

	/** The backing array. */
	private float[] array;

	/**
	 * Constructs an extensible array of floats, backed by a fixed-size array.
	 */
	public FloatArray() {
		super(Float.TYPE);
	}

	/**
	 * Constructs an extensible array of floats, backed by a fixed-size array.
	 * 
	 * @param size the initial size
	 */
	public FloatArray(final int size) {
		super(Float.TYPE, size);
	}

	/**
	 * Constructs an extensible array of floats, backed by the given fixed-size
	 * array.
	 * 
	 * @param array the array to wrap
	 */
	public FloatArray(final float[] array) {
		super(Float.TYPE, array);
	}

	// -- FloatArray methods --

	public void addValue(final float value) {
		addValue(size(), value);
	}

	public boolean removeValue(final float value) {
		final int index = indexOf(value);
		if (index < 0) return false;
		delete(index, 1);
		return true;
	}

	public float getValue(final int index) {
		checkBounds(index);
		return array[index];
	}

	public float setValue(final int index, final float value) {
		checkBounds(index);
		final float oldValue = getValue(index);
		array[index] = value;
		return oldValue;
	}

	public void addValue(final int index, final float value) {
		insert(index, 1);
		array[index] = value;
	}

	public int indexOf(final float value) {
		for (int i = 0; i < size(); i++) {
			if (array[i] == value) return i;
		}
		return -1;
	}

	public int lastIndexOf(final float value) {
		for (int i = size() - 1; i >= 0; i--) {
			if (array[i] == value) return i;
		}
		return -1;
	}

	public boolean contains(final float value) {
		return indexOf(value) >= 0;
	}

	// -- PrimitiveArray methods --

	@Override
	public float[] getArray() {
		return array;
	}

	@Override
	public void setArray(final float[] array) {
		if (array.length < size()) {
			throw new IllegalArgumentException("Array too small");
		}
		this.array = array;
	}

	// -- List methods --

	@Override
	public Float get(final int index) {
		return getValue(index);
	}

	@Override
	public Float set(final int index, final Float element) {
		return setValue(index, element == null ? defaultValue() : element);
	}

	@Override
	public void add(final int index, final Float element) {
		addValue(index, element);
	}

	// NB: Overridden for performance.
	@Override
	public int indexOf(final Object o) {
		if (!(o instanceof Float)) return -1;
		final float value = (Float) o;
		return indexOf(value);
	}

	// NB: Overridden for performance.
	@Override
	public int lastIndexOf(final Object o) {
		if (!(o instanceof Float)) return -1;
		final float value = (Float) o;
		return lastIndexOf(value);
	}

	// -- Collection methods --

	// NB: Overridden for performance.
	@Override
	public boolean contains(final Object o) {
		if (!(o instanceof Float)) return false;
		final float value = (Float) o;
		return contains(value);
	}

	// NB: Overridden for performance.
	@Override
	public boolean remove(final Object o) {
		if (!(o instanceof Float)) return false;
		final float value = (Float) o;
		return removeValue(value);
	}

	// NB: Overridden for performance.
	@Override
	public boolean containsAll(final Collection c) {
		for (final Object o : c) {
			if (!(o instanceof Float)) return false;
			final float value = (Float) o;
			if (indexOf(value) < 0) return false;
		}
		return true;
	}

	// NB: Overridden for performance.
	@Override
	public boolean addAll(final int index, final Collection c) {
		if (c.size() == 0) return false;
		insert(index, c.size());
		int i = index;
		for (final float e : c) {
			setValue(i++, e);
		}
		return true;
	}

	// NB: Overridden for performance.
	@Override
	public boolean removeAll(final Collection c) {
		boolean changed = false;
		for (final Object o : c) {
			if (!(o instanceof Float)) continue;
			final float value = (Float) o;
			final boolean result = removeValue(value);
			if (result) changed = true;
		}
		return changed;
	}

	@Override
	public Float defaultValue() {
		return 0.0f;
	}

}