All Downloads are FREE. Search and download functionalities are using the official Maven repository.

drv.Lists.drv Maven / Gradle / Ivy

Go to download

fastutil extends the Java Collections Framework by providing type-specific maps, sets, lists and priority queues with a small memory footprint and fast access and insertion; provides also big (64-bit) arrays, sets and lists, and fast, practical I/O classes for binary and text files.

There is a newer version: 8.5.15
Show newest version
/*
 * Copyright (C) 2002-2017 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 PACKAGE;

import java.util.List;
import java.util.Collection;
import java.util.Random;
import java.util.RandomAccess;

/** A class providing static methods and objects that do useful things with type-specific lists.
 *
 * @see java.util.Collections
 */

public final class LISTS {

	private LISTS() {}

	/** Shuffles the specified list using the specified pseudorandom number generator.
	 *
	 * @param l the list to be shuffled.
	 * @param random a pseudorandom number generator.
	 * @return {@code l}.
	 */
	public static KEY_GENERIC LIST KEY_GENERIC shuffle(final LIST KEY_GENERIC l, final Random random) {
		for(int i = l.size(); i-- != 0;) {
			final int p = random.nextInt(i + 1);
			final KEY_GENERIC_TYPE t = l.GET_KEY(i);
			l.set(i, l.GET_KEY(p));
			l.set(p, t);
		}
		return l;
	}

	/** An immutable class representing an empty type-specific list.
	 *
	 * 

This class may be useful to implement your own in case you subclass * a type-specific list. */ public static class EmptyList KEY_GENERIC extends COLLECTIONS.EmptyCollection KEY_GENERIC implements LIST KEY_GENERIC, RandomAccess, java.io.Serializable, Cloneable { private static final long serialVersionUID = -7046029254386353129L; protected EmptyList() {} @Override public KEY_GENERIC_TYPE GET_KEY(int i) { throw new IndexOutOfBoundsException(); } @Override public boolean REMOVE(KEY_TYPE k) { throw new UnsupportedOperationException(); } @Override public KEY_GENERIC_TYPE REMOVE_KEY(int i) { throw new UnsupportedOperationException(); } @Override public void add(final int index, final KEY_GENERIC_TYPE k) { throw new UnsupportedOperationException(); } @Override public KEY_GENERIC_TYPE set(final int index, final KEY_GENERIC_TYPE k) { throw new UnsupportedOperationException(); } @Override public int indexOf(KEY_TYPE k) { return -1; } @Override public int lastIndexOf(KEY_TYPE k) { return -1; } @Override public boolean addAll(int i, Collection c) { throw new UnsupportedOperationException(); } #if KEYS_PRIMITIVE @Override public boolean addAll(LIST c) { throw new UnsupportedOperationException(); } @Override public boolean addAll(int i, COLLECTION c) { throw new UnsupportedOperationException(); } @Override public boolean addAll(int i, LIST c) { throw new UnsupportedOperationException(); } /** {@inheritDoc} * @deprecated Please use the corresponding type-specific method instead. */ @SuppressWarnings("deprecation") @Deprecated @Override public void add(final int index, final KEY_GENERIC_CLASS k) { throw new UnsupportedOperationException(); } /** {@inheritDoc} * @deprecated Please use the corresponding type-specific method instead. */ @SuppressWarnings("deprecation") @Deprecated @Override public KEY_CLASS get(final int index) { throw new UnsupportedOperationException(); } /** {@inheritDoc} * @deprecated Please use the corresponding type-specific method instead. */ @SuppressWarnings("deprecation") @Deprecated @Override public boolean add(final KEY_GENERIC_CLASS k) { throw new UnsupportedOperationException(); } /** {@inheritDoc} * @deprecated Please use the corresponding type-specific method instead. */ @SuppressWarnings("deprecation") @Deprecated @Override public KEY_GENERIC_CLASS set(final int index, final KEY_GENERIC_CLASS k) { throw new UnsupportedOperationException(); } /** {@inheritDoc} * @deprecated Please use the corresponding type-specific method instead. */ @SuppressWarnings("deprecation") @Deprecated @Override public KEY_GENERIC_CLASS remove(int k) { throw new UnsupportedOperationException(); } /** {@inheritDoc} * @deprecated Please use the corresponding type-specific method instead. */ @SuppressWarnings("deprecation") @Deprecated @Override public int indexOf(Object k) { return -1; } /** {@inheritDoc} * @deprecated Please use the corresponding type-specific method instead. */ @SuppressWarnings("deprecation") @Deprecated @Override public int lastIndexOf(Object k) { return -1; } #endif SUPPRESS_WARNINGS_KEY_UNCHECKED @Override public KEY_LIST_ITERATOR KEY_GENERIC listIterator() { return ITERATORS.EMPTY_ITERATOR; } SUPPRESS_WARNINGS_KEY_UNCHECKED @Override public KEY_LIST_ITERATOR KEY_GENERIC iterator() { return ITERATORS.EMPTY_ITERATOR; } SUPPRESS_WARNINGS_KEY_UNCHECKED @Override public KEY_LIST_ITERATOR KEY_GENERIC listIterator(int i) { if (i == 0) return ITERATORS.EMPTY_ITERATOR; throw new IndexOutOfBoundsException(String.valueOf(i)); } @Override public LIST KEY_GENERIC subList(int from, int to) { if (from == 0 && to == 0) return this; throw new IndexOutOfBoundsException(); } @Override public void getElements(int from, KEY_TYPE[] a, int offset, int length) { if (from == 0 && length == 0 && offset >= 0 && offset <= a.length) return; throw new IndexOutOfBoundsException(); } @Override public void removeElements(int from, int to) { throw new UnsupportedOperationException(); } @Override public void addElements(int index, final KEY_GENERIC_TYPE a[], int offset, int length) { throw new UnsupportedOperationException(); } @Override public void addElements(int index, final KEY_GENERIC_TYPE a[]) { throw new UnsupportedOperationException(); } @Override public void size(int s) { throw new UnsupportedOperationException(); } #if ! KEY_CLASS_Reference @Override public int compareTo(final List o) { if (o == this) return 0; return ((List)o).isEmpty() ? 0 : -1; } #endif @Override public Object clone() { return EMPTY_LIST; } @Override public int hashCode() { return 1; } @Override @SuppressWarnings("rawtypes") public boolean equals(Object o) { return o instanceof List && ((List)o).isEmpty(); } @Override public String toString() { return "[]"; } private Object readResolve() { return EMPTY_LIST; } } /** An empty list (immutable). It is serializable and cloneable. */ SUPPRESS_WARNINGS_KEY_RAWTYPES public static final EmptyList EMPTY_LIST = new EmptyList(); #if KEYS_REFERENCE /** Returns an empty list (immutable). It is serializable and cloneable. * *

This method provides a typesafe access to {@link #EMPTY_LIST}. * @return an empty list (immutable). */ @SuppressWarnings("unchecked") public static KEY_GENERIC LIST KEY_GENERIC emptyList() { return EMPTY_LIST; } #endif /** An immutable class representing a type-specific singleton list. * *

This class may be useful to implement your own in case you subclass * a type-specific list. */ public static class Singleton KEY_GENERIC extends ABSTRACT_LIST KEY_GENERIC implements RandomAccess, java.io.Serializable, Cloneable { private static final long serialVersionUID = -7046029254386353129L; private final KEY_GENERIC_TYPE element; protected Singleton(final KEY_GENERIC_TYPE element) { this.element = element; } @Override public KEY_GENERIC_TYPE GET_KEY(final int i) { if (i == 0) return element; throw new IndexOutOfBoundsException(); } @Override public boolean REMOVE(KEY_TYPE k) { throw new UnsupportedOperationException(); } @Override public KEY_GENERIC_TYPE REMOVE_KEY(final int i) { throw new UnsupportedOperationException(); } @Override public boolean contains(final KEY_TYPE k) { return KEY_EQUALS(k, element); } /* Slightly optimized w.r.t. the one in ABSTRACT_SET. */ @Override public KEY_TYPE[] TO_KEY_ARRAY() { KEY_TYPE a[] = new KEY_TYPE[1]; a[0] = element; return a; } @Override public KEY_LIST_ITERATOR KEY_GENERIC listIterator() { return ITERATORS.singleton(element); } @Override public KEY_LIST_ITERATOR KEY_GENERIC iterator() { return listIterator(); } @Override public KEY_LIST_ITERATOR KEY_GENERIC listIterator(final int i) { if (i > 1 || i < 0) throw new IndexOutOfBoundsException(); final KEY_LIST_ITERATOR KEY_GENERIC l = listIterator(); if (i == 1) l.NEXT_KEY(); return l; } @Override SUPPRESS_WARNINGS_KEY_UNCHECKED public LIST KEY_GENERIC 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 + ")"); if (from != 0 || to != 1) return EMPTY_LIST; return this; } @Override public boolean addAll(int i, Collection c) { throw new UnsupportedOperationException(); } @Override public boolean addAll(final Collection c) { throw new UnsupportedOperationException(); } @Override public boolean removeAll(final Collection c) { throw new UnsupportedOperationException(); } @Override public boolean retainAll(final Collection c) { throw new UnsupportedOperationException(); } #if KEYS_PRIMITIVE @Override public boolean addAll(LIST c) { throw new UnsupportedOperationException(); } @Override public boolean addAll(int i, LIST c) { throw new UnsupportedOperationException(); } @Override public boolean addAll(int i, COLLECTION c) { throw new UnsupportedOperationException(); } @Override public boolean addAll(final COLLECTION c) { throw new UnsupportedOperationException(); } @Override public boolean removeAll(final COLLECTION c) { throw new UnsupportedOperationException(); } @Override public boolean retainAll(final COLLECTION c) { throw new UnsupportedOperationException(); } #endif @Override public int size() { return 1; } @Override public void size(final int size) { throw new UnsupportedOperationException(); } @Override public void clear() { throw new UnsupportedOperationException(); } @Override public Object clone() { return this; } } /** Returns a type-specific immutable list containing only the specified element. The returned list is serializable and cloneable. * * @param element the only element of the returned list. * @return a type-specific immutable list containing just {@code element}. */ public static KEY_GENERIC LIST KEY_GENERIC singleton(final KEY_GENERIC_TYPE element) { return new Singleton KEY_GENERIC_DIAMOND(element); } #if KEYS_PRIMITIVE /** Returns a type-specific immutable list containing only the specified element. The returned list is serializable and cloneable. * * @param element the only element of the returned list. * @return a type-specific immutable list containing just {@code element}. */ public static KEY_GENERIC LIST KEY_GENERIC singleton(final Object element) { return new Singleton KEY_GENERIC_DIAMOND(KEY_OBJ2TYPE(element)); } #endif /** A synchronized wrapper class for lists. */ public static class SynchronizedList KEY_GENERIC extends COLLECTIONS.SynchronizedCollection KEY_GENERIC implements LIST KEY_GENERIC, java.io.Serializable { private static final long serialVersionUID = -7046029254386353129L; protected final LIST KEY_GENERIC list; // Due to the large number of methods that are not in COLLECTION, this is worth caching. protected SynchronizedList(final LIST KEY_GENERIC l, final Object sync) { super(l, sync); this.list = l; } protected SynchronizedList(final LIST KEY_GENERIC l) { super(l); this.list = l; } @Override public KEY_GENERIC_TYPE GET_KEY(final int i) { synchronized(sync) { return list.GET_KEY(i); } } @Override public KEY_GENERIC_TYPE set(final int i, final KEY_GENERIC_TYPE k) { synchronized(sync) { return list.set(i, k); } } @Override public void add(final int i, final KEY_GENERIC_TYPE k) { synchronized(sync) { list.add(i, k); } } @Override public KEY_GENERIC_TYPE REMOVE_KEY(final int i) { synchronized(sync) { return list.REMOVE_KEY(i); } } @Override public int indexOf(final KEY_TYPE k) { synchronized(sync) { return list.indexOf(k); } } @Override public int lastIndexOf(final KEY_TYPE k) { synchronized(sync) { return list.lastIndexOf(k); } } @Override public boolean addAll(final int index, final Collection c) { synchronized(sync) { return list.addAll(index, c); } } @Override public void getElements(final int from, final KEY_TYPE a[], final int offset, final int length) { synchronized(sync) { list.getElements(from, a, offset, length); } } @Override public void removeElements(final int from, final int to) { synchronized(sync) { list.removeElements(from, to); } } @Override public void addElements(int index, final KEY_GENERIC_TYPE a[], int offset, int length) { synchronized(sync) { list.addElements(index, a, offset, length); } } @Override public void addElements(int index, final KEY_GENERIC_TYPE a[]) { synchronized(sync) { list.addElements(index, a); } } @Override public void size(final int size) { synchronized(sync) { list.size(size); } } @Override public KEY_LIST_ITERATOR KEY_GENERIC listIterator() { return list.listIterator(); } @Override public KEY_LIST_ITERATOR KEY_GENERIC iterator() { return listIterator(); } @Override public KEY_LIST_ITERATOR KEY_GENERIC listIterator(final int i) { return list.listIterator(i); } @Override public LIST KEY_GENERIC subList(final int from, final int to) { synchronized(sync) { return new SynchronizedList KEY_GENERIC_DIAMOND(list.subList(from, to), sync); } } @Override public boolean equals(final Object o) { if (o == this) return true; synchronized(sync) { return collection.equals(o); } } @Override public int hashCode() { synchronized(sync) { return collection.hashCode(); } } #if ! KEY_CLASS_Reference @Override public int compareTo(final List o) { synchronized(sync) { return list.compareTo(o); } } #endif #if KEYS_PRIMITIVE @Override public boolean addAll(final int index, final COLLECTION c) { synchronized(sync) { return list.addAll(index, c); } } @Override public boolean addAll(final int index, LIST l) { synchronized(sync) { return list.addAll(index, l); } } @Override public boolean addAll(LIST l) { synchronized(sync) { return list.addAll(l); } } /** {@inheritDoc} * @deprecated Please use the corresponding type-specific method instead. */ @Deprecated @Override public KEY_GENERIC_CLASS get(final int i) { synchronized(sync) { return list.get(i); } } /** {@inheritDoc} * @deprecated Please use the corresponding type-specific method instead. */ @Deprecated @Override public void add(final int i, KEY_GENERIC_CLASS k) { synchronized(sync) { list.add(i, k); } } /** {@inheritDoc} * @deprecated Please use the corresponding type-specific method instead. */ @Deprecated @Override public KEY_GENERIC_CLASS set(final int index, KEY_GENERIC_CLASS k) { synchronized(sync) { return list.set(index, k); } } /** {@inheritDoc} * @deprecated Please use the corresponding type-specific method instead. */ @Deprecated @Override public KEY_GENERIC_CLASS remove(final int i) { synchronized(sync) { return list.remove(i); } } /** {@inheritDoc} * @deprecated Please use the corresponding type-specific method instead. */ @Deprecated @Override public int indexOf(final Object o) { synchronized(sync) { return list.indexOf(o); } } /** {@inheritDoc} * @deprecated Please use the corresponding type-specific method instead. */ @Deprecated @Override public int lastIndexOf(final Object o) { synchronized(sync) { return list.lastIndexOf(o); } } #endif private void writeObject(java.io.ObjectOutputStream s) throws java.io.IOException { synchronized(sync) { s.defaultWriteObject(); } } } /** A synchronized wrapper class for random-access lists. */ public static class SynchronizedRandomAccessList KEY_GENERIC extends SynchronizedList KEY_GENERIC implements RandomAccess, java.io.Serializable { private static final long serialVersionUID = 0L; protected SynchronizedRandomAccessList(final LIST KEY_GENERIC l, final Object sync) { super(l, sync); } protected SynchronizedRandomAccessList(final LIST KEY_GENERIC l) { super(l); } @Override public LIST KEY_GENERIC subList(final int from, final int to) { synchronized(sync) { return new SynchronizedRandomAccessList KEY_GENERIC_DIAMOND(list.subList(from, to), sync); } } } /** Returns a synchronized type-specific list backed by the given type-specific list. * * @param l the list to be wrapped in a synchronized list. * @return a synchronized view of the specified list. * @see java.util.Collections#synchronizedList(List) */ public static KEY_GENERIC LIST KEY_GENERIC synchronize(final LIST KEY_GENERIC l) { return l instanceof RandomAccess ? new SynchronizedRandomAccessList KEY_GENERIC_DIAMOND(l) : new SynchronizedList KEY_GENERIC_DIAMOND(l); } /** Returns a synchronized type-specific list backed by the given type-specific list, using an assigned object to synchronize. * * @param l the list to be wrapped in a synchronized list. * @param sync an object that will be used to synchronize the access to the list. * @return a synchronized view of the specified list. * @see java.util.Collections#synchronizedList(List) */ public static KEY_GENERIC LIST KEY_GENERIC synchronize(final LIST KEY_GENERIC l, final Object sync) { return l instanceof RandomAccess ? new SynchronizedRandomAccessList KEY_GENERIC_DIAMOND(l, sync) : new SynchronizedList KEY_GENERIC_DIAMOND(l, sync); } /** An unmodifiable wrapper class for lists. */ public static class UnmodifiableList KEY_GENERIC extends COLLECTIONS.UnmodifiableCollection KEY_GENERIC implements LIST KEY_GENERIC, java.io.Serializable { private static final long serialVersionUID = -7046029254386353129L; protected final LIST KEY_GENERIC list; // Due to the large number of methods that are not in COLLECTION, this is worth caching. protected UnmodifiableList(final LIST KEY_GENERIC l) { super(l); this.list = l; } @Override public KEY_GENERIC_TYPE GET_KEY(final int i) { return list.GET_KEY(i); } @Override public KEY_GENERIC_TYPE set(final int i, final KEY_GENERIC_TYPE k) { throw new UnsupportedOperationException(); } @Override public void add(final int i, final KEY_GENERIC_TYPE k) { throw new UnsupportedOperationException(); } @Override public KEY_GENERIC_TYPE REMOVE_KEY(final int i) { throw new UnsupportedOperationException(); } @Override public int indexOf(final KEY_TYPE k) { return list.indexOf(k); } @Override public int lastIndexOf(final KEY_TYPE k) { return list.lastIndexOf(k); } @Override public boolean addAll(final int index, final Collection c) { throw new UnsupportedOperationException(); } @Override public void getElements(final int from, final KEY_TYPE a[], final int offset, final int length) { list.getElements(from, a, offset, length); } @Override public void removeElements(final int from, final int to) { throw new UnsupportedOperationException(); } @Override public void addElements(int index, final KEY_GENERIC_TYPE a[], int offset, int length) { throw new UnsupportedOperationException(); } @Override public void addElements(int index, final KEY_GENERIC_TYPE a[]) { throw new UnsupportedOperationException(); } @Override public void size(final int size) { list.size(size); } @Override public KEY_LIST_ITERATOR KEY_GENERIC listIterator() { return ITERATORS.unmodifiable(list.listIterator()); } @Override public KEY_LIST_ITERATOR KEY_GENERIC iterator() { return listIterator(); } @Override public KEY_LIST_ITERATOR KEY_GENERIC listIterator(final int i) { return ITERATORS.unmodifiable(list.listIterator(i)); } @Override public LIST KEY_GENERIC subList(final int from, final int to) { return new UnmodifiableList KEY_GENERIC_DIAMOND(list.subList(from, to)); } @Override public boolean equals(final Object o) { if (o == this) return true; return collection.equals(o); } @Override public int hashCode() { return collection.hashCode(); } #if ! KEY_CLASS_Reference @Override public int compareTo(final List o) { return list.compareTo(o); } #endif #if KEYS_PRIMITIVE @Override public boolean addAll(final int index, final COLLECTION c) { throw new UnsupportedOperationException(); } @Override public boolean addAll(final LIST l) { throw new UnsupportedOperationException(); } @Override public boolean addAll(final int index, final LIST l) { throw new UnsupportedOperationException(); } /** {@inheritDoc} * @deprecated Please use the corresponding type-specific method instead. */ @Deprecated @Override public KEY_GENERIC_CLASS get(final int i) { return list.get(i); } /** {@inheritDoc} * @deprecated Please use the corresponding type-specific method instead. */ @Deprecated @Override public void add(final int i, KEY_GENERIC_CLASS k) { throw new UnsupportedOperationException(); } /** {@inheritDoc} * @deprecated Please use the corresponding type-specific method instead. */ @Deprecated @Override public KEY_GENERIC_CLASS set(final int index, KEY_GENERIC_CLASS k) { throw new UnsupportedOperationException(); } /** {@inheritDoc} * @deprecated Please use the corresponding type-specific method instead. */ @Deprecated @Override public KEY_GENERIC_CLASS remove(final int i) { throw new UnsupportedOperationException(); } /** {@inheritDoc} * @deprecated Please use the corresponding type-specific method instead. */ @Deprecated @Override public int indexOf(final Object o) { return list.indexOf(o); } /** {@inheritDoc} * @deprecated Please use the corresponding type-specific method instead. */ @Deprecated @Override public int lastIndexOf(final Object o) { return list.lastIndexOf(o); } #endif } /** An unmodifiable wrapper class for random-access lists. */ public static class UnmodifiableRandomAccessList KEY_GENERIC extends UnmodifiableList KEY_GENERIC implements RandomAccess, java.io.Serializable { private static final long serialVersionUID = 0L; protected UnmodifiableRandomAccessList(final LIST KEY_GENERIC l) { super(l); } @Override public LIST KEY_GENERIC subList(final int from, final int to) { return new UnmodifiableRandomAccessList KEY_GENERIC_DIAMOND(list.subList(from, to)); } } /** Returns an unmodifiable type-specific list backed by the given type-specific list. * * @param l the list to be wrapped in an unmodifiable list. * @return an unmodifiable view of the specified list. * @see java.util.Collections#unmodifiableList(List) */ public static KEY_GENERIC LIST KEY_GENERIC unmodifiable(final LIST KEY_GENERIC l) { return l instanceof RandomAccess ? new UnmodifiableRandomAccessList KEY_GENERIC_DIAMOND(l) : new UnmodifiableList KEY_GENERIC_DIAMOND(l); } #ifdef TEST private static KEY_TYPE genKey() { #if KEY_CLASS_Byte || KEY_CLASS_Short || KEY_CLASS_Character return (KEY_TYPE)(r.nextInt()); #elif KEYS_PRIMITIVE return r.NEXT_KEY(); #elif KEY_CLASS_Object return Integer.toBinaryString(r.nextInt()); #else return new java.io.Serializable() {}; #endif } private static void testLists(KEY_TYPE k, LIST m, List t, int level) { int n = 100; int c; long ms; boolean mThrowsIllegal, tThrowsIllegal, mThrowsNoElement, tThrowsNoElement, mThrowsIndex, tThrowsIndex, mThrowsUnsupp, tThrowsUnsupp; boolean rt = false, rm = false; Object Rt = null, Rm = null; if (level == 0) return; /* Now we check that m and t are equal. */ if (!m.equals(t) || ! t.equals(m)) System.err.println("m: " + m + " t: " + t); ensure(m.equals(t), "Error (" + level + ", " + seed + "): ! m.equals(t) at start"); ensure(t.equals(m), "Error (" + level + ", " + seed + "): ! t.equals(m) at start"); /* Now we check that m actually holds that data. */ for(java.util.Iterator i=t.iterator(); i.hasNext();) { ensure(m.contains(i.next()), "Error (" + level + ", " + seed + "): m and t differ on an entry after insertion (iterating on t)"); } /* Now we check that m actually holds that data, but iterating on m. */ for(java.util.Iterator i=m.listIterator(); i.hasNext();) { ensure(t.contains(i.next()), "Error (" + level + ", " + seed + "): m and t differ on an entry after insertion (iterating on m)"); } /* Now we check that inquiries about random data give the same answer in m and t. For m we use the polymorphic method. */ for(int i=0; i 1) r = new java.util.Random(seed = Long.parseLong(arg[1])); try { test(); } catch(Throwable e) { e.printStackTrace(System.err); System.err.println("seed: " + seed); } } #endif }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy