drv.Lists.drv Maven / Gradle / Ivy
Show all versions of fastutil Show documentation
/*
* 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 PACKAGE;
import java.util.List;
import java.util.Collection;
import java.util.Random;
/** A class providing static methods and objects that do useful things with type-specific lists.
*
* @see java.util.Collections
*/
public 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 (please use a XorShift* generator).
* @return 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, java.io.Serializable, Cloneable {
private static final long serialVersionUID = -7046029254386353129L;
protected EmptyList() {}
public void add( final int index, final KEY_GENERIC_TYPE k ) { throw new UnsupportedOperationException(); }
public boolean add( final KEY_GENERIC_TYPE k ) { throw new UnsupportedOperationException(); }
public KEY_GENERIC_TYPE REMOVE_KEY( int i ) { throw new UnsupportedOperationException(); }
public KEY_GENERIC_TYPE set( final int index, final KEY_GENERIC_TYPE k ) { throw new UnsupportedOperationException(); }
public int indexOf( KEY_TYPE k ) { return -1; }
public int lastIndexOf( KEY_TYPE k ) { return -1; }
public boolean addAll( Collection c ) { throw new UnsupportedOperationException(); }
public boolean addAll( int i, Collection c ) { throw new UnsupportedOperationException(); }
public boolean removeAll( Collection c ) { throw new UnsupportedOperationException(); }
public KEY_GENERIC_CLASS get( int i ) { throw new IndexOutOfBoundsException(); }
#if KEYS_PRIMITIVE
public boolean addAll( COLLECTION c ) { throw new UnsupportedOperationException(); }
public boolean addAll( LIST c ) { throw new UnsupportedOperationException(); }
public boolean addAll( int i, COLLECTION c ) { throw new UnsupportedOperationException(); }
public boolean addAll( int i, LIST c ) { throw new UnsupportedOperationException(); }
public void add( final int index, final KEY_GENERIC_CLASS k ) { throw new UnsupportedOperationException(); }
public boolean add( final KEY_GENERIC_CLASS k ) { throw new UnsupportedOperationException(); }
public KEY_GENERIC_CLASS set( final int index, final KEY_GENERIC_CLASS k ) { throw new UnsupportedOperationException(); }
public KEY_GENERIC_TYPE GET_KEY( int i ) { throw new IndexOutOfBoundsException(); }
public KEY_GENERIC_CLASS remove( int k ) { throw new UnsupportedOperationException(); }
public int indexOf( Object k ) { return -1; }
public int lastIndexOf( Object k ) { return -1; }
#endif
//SUPPRESS_WARNINGS_KEY_UNCHECKED
//public KEY_ITERATOR KEY_GENERIC iterator( int i ) { if ( i == 0 ) return ITERATORS.EMPTY_ITERATOR; throw new IndexOutOfBoundsException( String.valueOf( i ) ); }
@Deprecated
SUPPRESS_WARNINGS_KEY_UNCHECKED
public KEY_ITERATOR KEY_GENERIC KEY_ITERATOR_METHOD() { return ITERATORS.EMPTY_ITERATOR; }
SUPPRESS_WARNINGS_KEY_UNCHECKED
public KEY_LIST_ITERATOR KEY_GENERIC listIterator() { return ITERATORS.EMPTY_ITERATOR; }
SUPPRESS_WARNINGS_KEY_UNCHECKED
public KEY_LIST_ITERATOR KEY_GENERIC iterator() { return ITERATORS.EMPTY_ITERATOR; }
SUPPRESS_WARNINGS_KEY_UNCHECKED
public KEY_LIST_ITERATOR KEY_GENERIC listIterator( int i ) { if ( i == 0 ) return ITERATORS.EMPTY_ITERATOR; throw new IndexOutOfBoundsException( String.valueOf( i ) ); }
@Deprecated
public KEY_LIST_ITERATOR KEY_GENERIC KEY_LIST_ITERATOR_METHOD() { return listIterator(); }
@Deprecated
public KEY_LIST_ITERATOR KEY_GENERIC KEY_LIST_ITERATOR_METHOD( int i ) { return listIterator( i ); }
public LIST KEY_GENERIC subList( int from, int to ) { if ( from == 0 && to == 0 ) return this; throw new IndexOutOfBoundsException(); }
@Deprecated
public LIST KEY_GENERIC SUBLIST_METHOD( int from, int to ) { return subList( from, to ); }
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(); }
public void removeElements( int from, int to ) { throw new UnsupportedOperationException(); }
public void addElements( int index, final KEY_GENERIC_TYPE a[], int offset, int length ) { throw new UnsupportedOperationException(); }
public void addElements( int index, final KEY_GENERIC_TYPE a[] ) { throw new UnsupportedOperationException(); }
public void size( int s ) { throw new UnsupportedOperationException(); }
public int compareTo( final List o ) {
if ( o == this ) return 0;
return ((List)o).isEmpty() ? 0 : -1;
}
private Object readResolve() { return EMPTY_LIST; }
public Object clone() { return EMPTY_LIST; }
public int hashCode() { return 1; }
@SuppressWarnings("rawtypes")
public boolean equals( Object o ) { return o instanceof List && ((List)o).isEmpty(); }
public String toString() { return "[]"; }
}
/** An empty list (immutable). It is serializable and cloneable.
*/
SUPPRESS_WARNINGS_KEY_RAWTYPES
public static final EmptyList EMPTY_LIST = new EmptyList();
#if KEYS_REFERENCE
/** Return 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 java.io.Serializable, Cloneable {
private static final long serialVersionUID = -7046029254386353129L;
private final KEY_GENERIC_TYPE element;
private Singleton( final KEY_GENERIC_TYPE element ) {
this.element = element;
}
public KEY_GENERIC_TYPE GET_KEY( final int i ) { if ( i == 0 ) return element; throw new IndexOutOfBoundsException(); }
public KEY_GENERIC_TYPE REMOVE_KEY( final int i ) { throw new UnsupportedOperationException(); }
public boolean contains( final KEY_TYPE k ) { return KEY_EQUALS( k, element ); }
public boolean addAll( final Collection c ) { throw new UnsupportedOperationException(); }
public boolean addAll( final int i, final Collection c ) { throw new UnsupportedOperationException(); }
public boolean removeAll( final Collection c ) { throw new UnsupportedOperationException(); }
public boolean retainAll( final Collection c ) { throw new UnsupportedOperationException(); }
/* Slightly optimized w.r.t. the one in ABSTRACT_SET. */
public KEY_TYPE[] TO_KEY_ARRAY() {
KEY_TYPE a[] = new KEY_TYPE[ 1 ];
a[ 0 ] = element;
return a;
}
public KEY_LIST_ITERATOR KEY_GENERIC listIterator() { return ITERATORS.singleton( element ); }
public KEY_LIST_ITERATOR KEY_GENERIC iterator() { return listIterator(); }
public KEY_LIST_ITERATOR KEY_GENERIC listIterator( int i ) {
if ( i > 1 || i < 0 ) throw new IndexOutOfBoundsException();
KEY_LIST_ITERATOR KEY_GENERIC l = listIterator();
if ( i == 1 ) l.next();
return l;
}
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;
}
public int size() { return 1; }
public void size( final int size ) { throw new UnsupportedOperationException(); }
public void clear() { throw new UnsupportedOperationException(); }
public Object clone() { return this; }
#if KEYS_PRIMITIVE
public boolean rem( final KEY_GENERIC_TYPE k ) { throw new UnsupportedOperationException(); }
public boolean addAll( final COLLECTION c ) { throw new UnsupportedOperationException(); }
public boolean addAll( final int i, final COLLECTION c ) { throw new UnsupportedOperationException(); }
#else
public boolean remove( final Object k ) { throw new UnsupportedOperationException(); }
#endif
}
/** 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 element.
*/
public static KEY_GENERIC LIST KEY_GENERIC singleton( final KEY_GENERIC_TYPE element ) { return new Singleton KEY_GENERIC( element ); }
#if ! KEYS_REFERENCE
/** 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 element.
*/
public static KEY_GENERIC LIST KEY_GENERIC singleton( final Object element ) { return new Singleton KEY_GENERIC( 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;
}
public KEY_GENERIC_TYPE GET_KEY( final int i ) { synchronized( sync ) { return list.GET_KEY( i ); } }
public KEY_GENERIC_TYPE set( final int i, final KEY_GENERIC_TYPE k ) { synchronized( sync ) { return list.set( i, k ); } }
public void add( final int i, final KEY_GENERIC_TYPE k ) { synchronized( sync ) { list.add( i, k ); } }
public KEY_GENERIC_TYPE REMOVE_KEY( final int i ) { synchronized( sync ) { return list.REMOVE_KEY( i ); } }
public int indexOf( final KEY_TYPE k ) { synchronized( sync ) { return list.indexOf( k ); } }
public int lastIndexOf( final KEY_TYPE k ) { synchronized( sync ) { return list.lastIndexOf( k ); } }
public boolean addAll( final int index, final Collection c ) { synchronized( sync ) { return list.addAll( index, c ); } }
public void getElements( final int from, final KEY_TYPE a[], final int offset, final int length ) { synchronized( sync ) { list.getElements( from, a, offset, length ); } }
public void removeElements( final int from, final int to ) { synchronized( sync ) { list.removeElements( from, to ); } }
public void addElements( int index, final KEY_GENERIC_TYPE a[], int offset, int length ) { synchronized( sync ) { list.addElements( index, a, offset, length ); } }
public void addElements( int index, final KEY_GENERIC_TYPE a[] ) { synchronized( sync ) { list.addElements( index, a ); } }
public void size( final int size ) { synchronized( sync ) { list.size( size ); } }
public KEY_LIST_ITERATOR KEY_GENERIC iterator() { return list.listIterator(); }
public KEY_LIST_ITERATOR KEY_GENERIC listIterator() { return list.listIterator(); }
public KEY_LIST_ITERATOR KEY_GENERIC listIterator( final int i ) { return list.listIterator( i ); }
@Deprecated
public KEY_LIST_ITERATOR KEY_GENERIC KEY_LIST_ITERATOR_METHOD() { return listIterator(); }
@Deprecated
public KEY_LIST_ITERATOR KEY_GENERIC KEY_LIST_ITERATOR_METHOD( final int i ) { return listIterator( i ); }
public LIST KEY_GENERIC subList( final int from, final int to ) { synchronized( sync ) { return synchronize( list.subList( from, to ), sync ); } }
@Deprecated
public LIST KEY_GENERIC SUBLIST_METHOD( final int from, final int to ) { return subList( from, to ); }
public boolean equals( final Object o ) { synchronized( sync ) { return collection.equals( o ); } }
public int hashCode() { synchronized( sync ) { return collection.hashCode(); } }
#if ! KEY_CLASS_Reference
public int compareTo( final List o ) { synchronized( sync ) { return list.compareTo( o ); } }
#endif
#if KEYS_PRIMITIVE
public boolean addAll( final int index, final COLLECTION c ) { synchronized( sync ) { return list.addAll( index, c ); } }
public boolean addAll( final int index, LIST l ) { synchronized( sync ) { return list.addAll( index, l ); } }
public boolean addAll( LIST l ) { synchronized( sync ) { return list.addAll( l ); } }
public KEY_GENERIC_CLASS get( final int i ) { synchronized( sync ) { return list.get( i ); } }
public void add( final int i, KEY_GENERIC_CLASS k ) { synchronized( sync ) { list.add( i, k ); } }
public KEY_GENERIC_CLASS set( final int index, KEY_GENERIC_CLASS k ) { synchronized( sync ) { return list.set( index, k ); } }
public KEY_GENERIC_CLASS remove( final int i ) { synchronized( sync ) { return list.remove( i ); } }
public int indexOf( final Object o ) { synchronized( sync ) { return list.indexOf( o ); } }
public int lastIndexOf( final Object o ) { synchronized( sync ) { return list.lastIndexOf( o ); } }
#endif
}
/** 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 new SynchronizedList KEY_GENERIC( 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 new SynchronizedList KEY_GENERIC( 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;
}
public KEY_GENERIC_TYPE GET_KEY( final int i ) { return list.GET_KEY( i ); }
public KEY_GENERIC_TYPE set( final int i, final KEY_GENERIC_TYPE k ) { throw new UnsupportedOperationException(); }
public void add( final int i, final KEY_GENERIC_TYPE k ) { throw new UnsupportedOperationException(); }
public KEY_GENERIC_TYPE REMOVE_KEY( final int i ) { throw new UnsupportedOperationException(); }
public int indexOf( final KEY_TYPE k ) { return list.indexOf( k ); }
public int lastIndexOf( final KEY_TYPE k ) { return list.lastIndexOf( k ); }
public boolean addAll( final int index, final Collection c ) { throw new UnsupportedOperationException(); }
public void getElements( final int from, final KEY_TYPE a[], final int offset, final int length ) { list.getElements( from, a, offset, length ); }
public void removeElements( final int from, final int to ) { throw new UnsupportedOperationException(); }
public void addElements( int index, final KEY_GENERIC_TYPE a[], int offset, int length ) { throw new UnsupportedOperationException(); }
public void addElements( int index, final KEY_GENERIC_TYPE a[] ) { throw new UnsupportedOperationException(); }
public void size( final int size ) { list.size( size ); }
public KEY_LIST_ITERATOR KEY_GENERIC iterator() { return listIterator(); }
public KEY_LIST_ITERATOR KEY_GENERIC listIterator() { return ITERATORS.unmodifiable( list.listIterator() ); }
public KEY_LIST_ITERATOR KEY_GENERIC listIterator( final int i ) { return ITERATORS.unmodifiable( list.listIterator( i ) ); }
@Deprecated
public KEY_LIST_ITERATOR KEY_GENERIC KEY_LIST_ITERATOR_METHOD() { return listIterator(); }
@Deprecated
public KEY_LIST_ITERATOR KEY_GENERIC KEY_LIST_ITERATOR_METHOD( final int i ) { return listIterator( i ); }
public LIST KEY_GENERIC subList( final int from, final int to ) { return unmodifiable( list.subList( from, to ) ); }
@Deprecated
public LIST KEY_GENERIC SUBLIST_METHOD( final int from, final int to ) { return subList( from, to ); }
public boolean equals( final Object o ) { return collection.equals( o ); }
public int hashCode() { return collection.hashCode(); }
#if ! KEY_CLASS_Reference
public int compareTo( final List o ) { return list.compareTo( o ); }
#endif
#if KEYS_PRIMITIVE
public boolean addAll( final int index, final COLLECTION c ) { throw new UnsupportedOperationException(); }
public boolean addAll( final LIST l ) { throw new UnsupportedOperationException(); }
public boolean addAll( final int index, final LIST l ) { throw new UnsupportedOperationException(); }
public KEY_GENERIC_CLASS get( final int i ) { return list.get( i ); }
public void add( final int i, KEY_GENERIC_CLASS k ) { throw new UnsupportedOperationException(); }
public KEY_GENERIC_CLASS set( final int index, KEY_GENERIC_CLASS k ) { throw new UnsupportedOperationException(); }
public KEY_GENERIC_CLASS remove( final int i ) { throw new UnsupportedOperationException(); }
public int indexOf( final Object o ) { return list.indexOf( o ); }
public int lastIndexOf( final Object o ) { return list.lastIndexOf( o ); }
#endif
}
/** 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 new UnmodifiableList KEY_GENERIC( 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
}