it.unimi.dsi.fastutil.longs.AbstractLongList Maven / Gradle / Ivy
Show all versions of fastutil Show documentation
/* Generic definitions */
/* Assertions (useful to generate conditional code) */
/* Current type and class (and size, if applicable) */
/* Value methods */
/* Interfaces (keys) */
/* Interfaces (values) */
/* Abstract implementations (keys) */
/* Abstract implementations (values) */
/* Static containers (keys) */
/* Static containers (values) */
/* Implementations */
/* Synchronized wrappers */
/* Unmodifiable wrappers */
/* Other wrappers */
/* Methods (keys) */
/* Methods (values) */
/* Methods (keys/values) */
/* Methods that have special names depending on keys (but the special names depend on values) */
/* Equality */
/* Object/Reference-only definitions (keys) */
/* Primitive-type-only definitions (keys) */
/* Object/Reference-only definitions (values) */
/*
* Copyright (C) 2002-2016 Sebastiano Vigna
*
* 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 it.unimi.dsi.fastutil.longs;
import java.util.List;
import java.util.Iterator;
import java.util.ListIterator;
import java.util.Collection;
import java.util.NoSuchElementException;
/**
* An abstract class providing basic methods for lists implementing a
* type-specific list interface.
*
*
* As an additional bonus, this class implements on top of the list operations a
* type-specific stack.
*/
public abstract class AbstractLongList extends AbstractLongCollection
implements
LongList,
LongStack {
protected AbstractLongList() {
}
/**
* Ensures that the given index is nonnegative and not greater than the list
* size.
*
* @param index
* an index.
* @throws IndexOutOfBoundsException
* if the given index is negative or greater than the list size.
*/
protected void ensureIndex(final int index) {
if (index < 0)
throw new IndexOutOfBoundsException("Index (" + index
+ ") is negative");
if (index > size())
throw new IndexOutOfBoundsException("Index (" + index
+ ") is greater than list size (" + (size()) + ")");
}
/**
* Ensures that the given index is nonnegative and smaller than the list
* size.
*
* @param index
* an index.
* @throws IndexOutOfBoundsException
* if the given index is negative or not smaller than the list
* size.
*/
protected void ensureRestrictedIndex(final int index) {
if (index < 0)
throw new IndexOutOfBoundsException("Index (" + index
+ ") is negative");
if (index >= size())
throw new IndexOutOfBoundsException("Index (" + index
+ ") is greater than or equal to list size (" + (size())
+ ")");
}
public void add(final int index, final long k) {
throw new UnsupportedOperationException();
}
public boolean add(final long k) {
add(size(), k);
return true;
}
public long removeLong(int i) {
throw new UnsupportedOperationException();
}
public long set(final int index, final long k) {
throw new UnsupportedOperationException();
}
public boolean addAll(int index, final Collection c) {
ensureIndex(index);
int n = c.size();
if (n == 0)
return false;
Iterator i = c.iterator();
while (n-- != 0)
add(index++, i.next());
return true;
}
/** Delegates to a more generic method. */
public boolean addAll(final Collection c) {
return addAll(size(), c);
}
/** Delegates to the new covariantly stronger generic method. */
@Deprecated
public LongListIterator longListIterator() {
return listIterator();
}
/** Delegates to the new covariantly stronger generic method. */
@Deprecated
public LongListIterator longListIterator(final int index) {
return listIterator(index);
}
public LongListIterator iterator() {
return listIterator();
}
public LongListIterator listIterator() {
return listIterator(0);
}
public LongListIterator listIterator(final int index) {
ensureIndex(index);
return new AbstractLongListIterator() {
int pos = index, last = -1;
public boolean hasNext() {
return pos < AbstractLongList.this.size();
}
public boolean hasPrevious() {
return pos > 0;
}
public long nextLong() {
if (!hasNext())
throw new NoSuchElementException();
return AbstractLongList.this.getLong(last = pos++);
}
public long previousLong() {
if (!hasPrevious())
throw new NoSuchElementException();
return AbstractLongList.this.getLong(last = --pos);
}
public int nextIndex() {
return pos;
}
public int previousIndex() {
return pos - 1;
}
public void add(long k) {
AbstractLongList.this.add(pos++, k);
last = -1;
}
public void set(long k) {
if (last == -1)
throw new IllegalStateException();
AbstractLongList.this.set(last, k);
}
public void remove() {
if (last == -1)
throw new IllegalStateException();
AbstractLongList.this.removeLong(last);
/*
* If the last operation was a next(), we are removing an
* element *before* us, and we must decrease pos
* correspondingly.
*/
if (last < pos)
pos--;
last = -1;
}
};
}
public boolean contains(final long k) {
return indexOf(k) >= 0;
}
public int indexOf(final long k) {
final LongListIterator i = listIterator();
long e;
while (i.hasNext()) {
e = i.nextLong();
if (((k) == (e)))
return i.previousIndex();
}
return -1;
}
public int lastIndexOf(final long k) {
LongListIterator i = listIterator(size());
long e;
while (i.hasPrevious()) {
e = i.previousLong();
if (((k) == (e)))
return i.nextIndex();
}
return -1;
}
public void size(final int size) {
int i = size();
if (size > i)
while (i++ < size)
add((0));
else
while (i-- != size)
remove(i);
}
public LongList subList(final int from, final int to) {
ensureIndex(from);
ensureIndex(to);
if (from > to)
throw new IndexOutOfBoundsException("Start index (" + from
+ ") is greater than end index (" + to + ")");
return new LongSubList(this, from, to);
}
/** Delegates to the new covariantly stronger generic method. */
@Deprecated
public LongList longSubList(final int from, final int to) {
return subList(from, to);
}
/**
* Removes elements of this type-specific list one-by-one.
*
*
* This is a trivial iterator-based implementation. It is expected that
* implementations will override this method with a more optimized version.
*
*
* @param from
* the start index (inclusive).
* @param to
* the end index (exclusive).
*/
public void removeElements(final int from, final int to) {
ensureIndex(to);
LongListIterator i = listIterator(from);
int n = to - from;
if (n < 0)
throw new IllegalArgumentException("Start index (" + from
+ ") is greater than end index (" + to + ")");
while (n-- != 0) {
i.nextLong();
i.remove();
}
}
/**
* Adds elements to this type-specific list one-by-one.
*
*
* This is a trivial iterator-based implementation. It is expected that
* implementations will override this method with a more optimized version.
*
* @param index
* the index at which to add elements.
* @param a
* the array containing the elements.
* @param offset
* the offset of the first element to add.
* @param length
* the number of elements to add.
*/
public void addElements(int index, final long a[], int offset, int length) {
ensureIndex(index);
if (offset < 0)
throw new ArrayIndexOutOfBoundsException("Offset (" + offset
+ ") is negative");
if (offset + length > a.length)
throw new ArrayIndexOutOfBoundsException("End index ("
+ (offset + length) + ") is greater than array length ("
+ a.length + ")");
while (length-- != 0)
add(index++, a[offset++]);
}
public void addElements(final int index, final long a[]) {
addElements(index, a, 0, a.length);
}
/**
* Copies element of this type-specific list into the given array
* one-by-one.
*
*
* This is a trivial iterator-based implementation. It is expected that
* implementations will override this method with a more optimized version.
*
* @param from
* the start index (inclusive).
* @param a
* the destination array.
* @param offset
* the offset into the destination array where to store the first
* element copied.
* @param length
* the number of elements to be copied.
*/
public void getElements(final int from, final long a[], int offset,
int length) {
LongListIterator i = listIterator(from);
if (offset < 0)
throw new ArrayIndexOutOfBoundsException("Offset (" + offset
+ ") is negative");
if (offset + length > a.length)
throw new ArrayIndexOutOfBoundsException("End index ("
+ (offset + length) + ") is greater than array length ("
+ a.length + ")");
if (from + length > size())
throw new IndexOutOfBoundsException("End index (" + (from + length)
+ ") is greater than list size (" + size() + ")");
while (length-- != 0)
a[offset++] = i.nextLong();
}
private boolean valEquals(final Object a, final Object b) {
return a == null ? b == null : a.equals(b);
}
public boolean equals(final Object o) {
if (o == this)
return true;
if (!(o instanceof List))
return false;
final List l = (List) o;
int s = size();
if (s != l.size())
return false;
if (l instanceof LongList) {
final LongListIterator i1 = listIterator(), i2 = ((LongList) l)
.listIterator();
while (s-- != 0)
if (i1.nextLong() != i2.nextLong())
return false;
return true;
}
final ListIterator i1 = listIterator(), i2 = l.listIterator();
while (s-- != 0)
if (!valEquals(i1.next(), i2.next()))
return false;
return true;
}
/**
* Compares this list to another object. If the argument is a
* {@link java.util.List}, this method performs a lexicographical
* comparison; otherwise, it throws a ClassCastException.
*
* @param l
* a list.
* @return if the argument is a {@link java.util.List}, a negative integer,
* zero, or a positive integer as this list is lexicographically
* less than, equal to, or greater than the argument.
* @throws ClassCastException
* if the argument is not a list.
*/
public int compareTo(final List l) {
if (l == this)
return 0;
if (l instanceof LongList) {
final LongListIterator i1 = listIterator(), i2 = ((LongList) l)
.listIterator();
int r;
long e1, e2;
while (i1.hasNext() && i2.hasNext()) {
e1 = i1.nextLong();
e2 = i2.nextLong();
if ((r = (Long.compare((e1), (e2)))) != 0)
return r;
}
return i2.hasNext() ? -1 : (i1.hasNext() ? 1 : 0);
}
ListIterator i1 = listIterator(), i2 = l.listIterator();
int r;
while (i1.hasNext() && i2.hasNext()) {
if ((r = ((Comparable) i1.next())
.compareTo(i2.next())) != 0)
return r;
}
return i2.hasNext() ? -1 : (i1.hasNext() ? 1 : 0);
}
/**
* Returns the hash code for this list, which is identical to
* {@link java.util.List#hashCode()}.
*
* @return the hash code for this list.
*/
public int hashCode() {
LongIterator i = iterator();
int h = 1, s = size();
while (s-- != 0) {
long k = i.nextLong();
h = 31 * h + it.unimi.dsi.fastutil.HashCommon.long2int(k);
}
return h;
}
public void push(long o) {
add(o);
}
public long popLong() {
if (isEmpty())
throw new NoSuchElementException();
return removeLong(size() - 1);
}
public long topLong() {
if (isEmpty())
throw new NoSuchElementException();
return getLong(size() - 1);
}
public long peekLong(int i) {
return getLong(size() - 1 - i);
}
public boolean rem(long k) {
int index = indexOf(k);
if (index == -1)
return false;
removeLong(index);
return true;
}
/** Delegates to rem(). */
public boolean remove(final Object o) {
return rem(((((Long) (o)).longValue())));
}
/** Delegates to a more generic method. */
public boolean addAll(final int index, final LongCollection c) {
return addAll(index, (Collection) c);
}
/** Delegates to a more generic method. */
public boolean addAll(final int index, final LongList l) {
return addAll(index, (LongCollection) l);
}
public boolean addAll(final LongCollection c) {
return addAll(size(), c);
}
public boolean addAll(final LongList l) {
return addAll(size(), l);
}
/** Delegates to the corresponding type-specific method. */
public void add(final int index, final Long ok) {
add(index, ok.longValue());
}
/**
* Delegates to the corresponding type-specific method.
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
public Long set(final int index, final Long ok) {
return (Long.valueOf(set(index, ok.longValue())));
}
/**
* Delegates to the corresponding type-specific method.
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
public Long get(final int index) {
return (Long.valueOf(getLong(index)));
}
/** Delegates to the corresponding type-specific method. */
public int indexOf(final Object ok) {
return indexOf(((((Long) (ok)).longValue())));
}
/** Delegates to the corresponding type-specific method. */
public int lastIndexOf(final Object ok) {
return lastIndexOf(((((Long) (ok)).longValue())));
}
/**
* Delegates to the corresponding type-specific method.
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
public Long remove(final int index) {
return (Long.valueOf(removeLong(index)));
}
/** Delegates to the corresponding type-specific method. */
public void push(Long o) {
push(o.longValue());
}
/**
* Delegates to the corresponding type-specific method.
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
public Long pop() {
return Long.valueOf(popLong());
}
/**
* Delegates to the corresponding type-specific method.
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
public Long top() {
return Long.valueOf(topLong());
}
/**
* Delegates to the corresponding type-specific method.
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
public Long peek(int i) {
return Long.valueOf(peekLong(i));
}
public String toString() {
final StringBuilder s = new StringBuilder();
final LongIterator i = iterator();
int n = size();
long k;
boolean first = true;
s.append("[");
while (n-- != 0) {
if (first)
first = false;
else
s.append(", ");
k = i.nextLong();
s.append(String.valueOf(k));
}
s.append("]");
return s.toString();
}
public static class LongSubList extends AbstractLongList
implements
java.io.Serializable {
private static final long serialVersionUID = -7046029254386353129L;
/** The list this sublist restricts. */
protected final LongList l;
/** Initial (inclusive) index of this sublist. */
protected final int from;
/** Final (exclusive) index of this sublist. */
protected int to;
private static final boolean ASSERTS = false;
public LongSubList(final LongList l, final int from, final int to) {
this.l = l;
this.from = from;
this.to = to;
}
private void assertRange() {
if (ASSERTS) {
assert from <= l.size();
assert to <= l.size();
assert to >= from;
}
}
public boolean add(final long k) {
l.add(to, k);
to++;
if (ASSERTS)
assertRange();
return true;
}
public void add(final int index, final long k) {
ensureIndex(index);
l.add(from + index, k);
to++;
if (ASSERTS)
assertRange();
}
public boolean addAll(final int index,
final Collection c) {
ensureIndex(index);
to += c.size();
if (ASSERTS) {
boolean retVal = l.addAll(from + index, c);
assertRange();
return retVal;
}
return l.addAll(from + index, c);
}
public long getLong(int index) {
ensureRestrictedIndex(index);
return l.getLong(from + index);
}
public long removeLong(int index) {
ensureRestrictedIndex(index);
to--;
return l.removeLong(from + index);
}
public long set(int index, long k) {
ensureRestrictedIndex(index);
return l.set(from + index, k);
}
public void clear() {
removeElements(0, size());
if (ASSERTS)
assertRange();
}
public int size() {
return to - from;
}
public void getElements(final int from, final long[] a,
final int offset, final int length) {
ensureIndex(from);
if (from + length > size())
throw new IndexOutOfBoundsException("End index (" + from
+ length + ") is greater than list size (" + size()
+ ")");
l.getElements(this.from + from, a, offset, length);
}
public void removeElements(final int from, final int to) {
ensureIndex(from);
ensureIndex(to);
l.removeElements(this.from + from, this.from + to);
this.to -= (to - from);
if (ASSERTS)
assertRange();
}
public void addElements(int index, final long a[], int offset,
int length) {
ensureIndex(index);
l.addElements(this.from + index, a, offset, length);
this.to += length;
if (ASSERTS)
assertRange();
}
public LongListIterator listIterator(final int index) {
ensureIndex(index);
return new AbstractLongListIterator() {
int pos = index, last = -1;
public boolean hasNext() {
return pos < size();
}
public boolean hasPrevious() {
return pos > 0;
}
public long nextLong() {
if (!hasNext())
throw new NoSuchElementException();
return l.getLong(from + (last = pos++));
}
public long previousLong() {
if (!hasPrevious())
throw new NoSuchElementException();
return l.getLong(from + (last = --pos));
}
public int nextIndex() {
return pos;
}
public int previousIndex() {
return pos - 1;
}
public void add(long k) {
if (last == -1)
throw new IllegalStateException();
LongSubList.this.add(pos++, k);
last = -1;
if (ASSERTS)
assertRange();
}
public void set(long k) {
if (last == -1)
throw new IllegalStateException();
LongSubList.this.set(last, k);
}
public void remove() {
if (last == -1)
throw new IllegalStateException();
LongSubList.this.removeLong(last);
/*
* If the last operation was a next(), we are removing an
* element *before* us, and we must decrease pos
* correspondingly.
*/
if (last < pos)
pos--;
last = -1;
if (ASSERTS)
assertRange();
}
};
}
public LongList subList(final int from, final int to) {
ensureIndex(from);
ensureIndex(to);
if (from > to)
throw new IllegalArgumentException("Start index (" + from
+ ") is greater than end index (" + to + ")");
return new LongSubList(this, from, to);
}
public boolean rem(long k) {
int index = indexOf(k);
if (index == -1)
return false;
to--;
l.removeLong(from + index);
if (ASSERTS)
assertRange();
return true;
}
public boolean remove(final Object o) {
return rem(((((Long) (o)).longValue())));
}
public boolean addAll(final int index, final LongCollection c) {
ensureIndex(index);
to += c.size();
if (ASSERTS) {
boolean retVal = l.addAll(from + index, c);
assertRange();
return retVal;
}
return l.addAll(from + index, c);
}
public boolean addAll(final int index, final LongList l) {
ensureIndex(index);
to += l.size();
if (ASSERTS) {
boolean retVal = this.l.addAll(from + index, l);
assertRange();
return retVal;
}
return this.l.addAll(from + index, l);
}
}
}