it.unimi.dsi.fastutil.longs.AbstractLong2ObjectMap Maven / Gradle / Ivy
Show all versions of fastutil-core Show documentation
/*
* Copyright (C) 2002-2021 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 static it.unimi.dsi.fastutil.Size64.sizeOf;
import it.unimi.dsi.fastutil.objects.ObjectCollection;
import it.unimi.dsi.fastutil.objects.AbstractObjectCollection;
import it.unimi.dsi.fastutil.objects.ObjectIterator;
import it.unimi.dsi.fastutil.objects.ObjectSpliterator;
import it.unimi.dsi.fastutil.objects.ObjectSpliterators;
import java.util.function.Consumer;
import it.unimi.dsi.fastutil.objects.AbstractObjectSet;
import java.util.Iterator;
import java.util.Map;
/**
* An abstract class providing basic methods for maps implementing a
* type-specific interface.
*
*
* Optional operations just throw an {@link UnsupportedOperationException}.
* Generic versions of accessors delegate to the corresponding type-specific
* counterparts following the interface rules (they take care of returning
* {@code null} on a missing key).
*
*
* As a further help, this class provides a {@link BasicEntry BasicEntry} inner
* class that implements a type-specific version of {@link java.util.Map.Entry};
* it is particularly useful for those classes that do not implement their own
* entries (e.g., most immutable maps).
*/
public abstract class AbstractLong2ObjectMap extends AbstractLong2ObjectFunction
implements
Long2ObjectMap,
java.io.Serializable {
private static final long serialVersionUID = -4940583368468432370L;
protected AbstractLong2ObjectMap() {
}
/**
* {@inheritDoc}
*
* @implSpec This implementation does a linear search over the entry set,
* finding an entry that has the key specified.
*
* If you override {@link #keySet()}, you should probably override
* this method too to take advantage of the (presumably) faster
* {@linkplain java.util.Set#contains key membership test} your
* {@link #keySet()} provides.
*
* If you override this method but not {@link #keySet()}, then the
* returned key set will take advantage of this method.
*/
@Override
public boolean containsKey(final long k) {
final ObjectIterator> i = long2ObjectEntrySet().iterator();
while (i.hasNext())
if (i.next().getLongKey() == k)
return true;
return false;
}
/**
* {@inheritDoc}
*
* @implSpec This implementation does a linear search over the entry set,
* finding an entry that has the value specified.
*
* If you override {@link #values()}, you should probably override
* this method too to take advantage of the (presumably) faster
* {@linkplain java.util.Collection#contains value membership test}
* your {@link #values()} provides.
*
* If you override this method but not {@link #values()}, then the
* returned values collection will take advantage of this method.
*/
@Override
public boolean containsValue(final Object v) {
final ObjectIterator> i = long2ObjectEntrySet().iterator();
while (i.hasNext())
if (i.next().getValue() == v)
return true;
return false;
}
@Override
public boolean isEmpty() {
return size() == 0;
}
/**
* This class provides a basic but complete type-specific entry class for all
* those maps implementations that do not have entries on their own (e.g., most
* immutable maps).
*
*
* This class does not implement {@link java.util.Map.Entry#setValue(Object)
* setValue()}, as the modification would not be reflected in the base map.
*/
public static class BasicEntry implements Long2ObjectMap.Entry {
protected long key;
protected V value;
public BasicEntry() {
}
public BasicEntry(final Long key, final V value) {
this.key = (key).longValue();
this.value = (value);
}
public BasicEntry(final long key, final V value) {
this.key = key;
this.value = value;
}
@Override
public long getLongKey() {
return key;
}
@Override
public V getValue() {
return value;
}
@Override
public V setValue(final V value) {
throw new UnsupportedOperationException();
}
@SuppressWarnings("unchecked")
@Override
public boolean equals(final Object o) {
if (!(o instanceof Map.Entry))
return false;
if (o instanceof Long2ObjectMap.Entry) {
final Long2ObjectMap.Entry e = (Long2ObjectMap.Entry) o;
return ((key) == (e.getLongKey())) && java.util.Objects.equals(value, e.getValue());
}
final Map.Entry e = (Map.Entry) o;
final Object key = e.getKey();
if (key == null || !(key instanceof Long))
return false;
final Object value = e.getValue();
return ((this.key) == (((Long) (key)).longValue())) && java.util.Objects.equals(this.value, (value));
}
@Override
public int hashCode() {
return it.unimi.dsi.fastutil.HashCommon.long2int(key) ^ ((value) == null ? 0 : (value).hashCode());
}
@Override
public String toString() {
return key + "->" + value;
}
}
/**
* This class provides a basic implementation for an Entry set which forwards
* some queries to the map.
*/
public abstract static class BasicEntrySet extends AbstractObjectSet> {
protected final Long2ObjectMap map;
public BasicEntrySet(final Long2ObjectMap map) {
this.map = map;
}
@SuppressWarnings("unchecked")
@Override
public boolean contains(final Object o) {
if (!(o instanceof Map.Entry))
return false;
if (o instanceof Long2ObjectMap.Entry) {
final Long2ObjectMap.Entry e = (Long2ObjectMap.Entry) o;
final long k = e.getLongKey();
return map.containsKey(k) && java.util.Objects.equals(map.get(k), e.getValue());
}
final Map.Entry e = (Map.Entry) o;
final Object key = e.getKey();
if (key == null || !(key instanceof Long))
return false;
final long k = ((Long) (key)).longValue();
final Object value = e.getValue();
return map.containsKey(k) && java.util.Objects.equals(map.get(k), (value));
}
@SuppressWarnings("unchecked")
@Override
public boolean remove(final Object o) {
if (!(o instanceof Map.Entry))
return false;
if (o instanceof Long2ObjectMap.Entry) {
final Long2ObjectMap.Entry e = (Long2ObjectMap.Entry) o;
return map.remove(e.getLongKey(), e.getValue());
}
Map.Entry e = (Map.Entry) o;
final Object key = e.getKey();
if (key == null || !(key instanceof Long))
return false;
final long k = ((Long) (key)).longValue();
final Object v = e.getValue();
return map.remove(k, v);
}
@Override
public int size() {
return map.size();
}
@Override
public ObjectSpliterator> spliterator() {
return ObjectSpliterators.asSpliterator(iterator(), sizeOf(map),
ObjectSpliterators.SET_SPLITERATOR_CHARACTERISTICS);
}
}
/**
* Returns a type-specific-set view of the keys of this map.
*
*
* The view is backed by the set returned by {@link Map#entrySet()}. Note that
* no attempt is made at caching the result of this method, as this
* would require adding some attributes that lightweight implementations would
* not need. Subclasses may easily override this policy by calling this method
* and caching the result, but implementors are encouraged to write more
* efficient ad-hoc implementations.
*
* @return a set view of the keys of this map; it may be safely cast to a
* type-specific interface.
*/
@Override
public LongSet keySet() {
return new AbstractLongSet() {
@Override
public boolean contains(final long k) {
return containsKey(k);
}
@Override
public int size() {
return AbstractLong2ObjectMap.this.size();
}
@Override
public void clear() {
AbstractLong2ObjectMap.this.clear();
}
@Override
public LongIterator iterator() {
return new LongIterator() {
private final ObjectIterator> i = Long2ObjectMaps
.fastIterator(AbstractLong2ObjectMap.this);
@Override
public long nextLong() {
return i.next().getLongKey();
}
@Override
public boolean hasNext() {
return i.hasNext();
}
@Override
public void remove() {
i.remove();
}
@Override
public void forEachRemaining(final java.util.function.LongConsumer action) {
i.forEachRemaining(entry -> action.accept(entry.getLongKey()));
}
};
}
@Override
public LongSpliterator spliterator() {
return LongSpliterators.asSpliterator(iterator(), sizeOf(AbstractLong2ObjectMap.this),
LongSpliterators.SET_SPLITERATOR_CHARACTERISTICS);
}
};
}
/**
* Returns a type-specific-set view of the values of this map.
*
*
* The view is backed by the set returned by {@link Map#entrySet()}. Note that
* no attempt is made at caching the result of this method, as this
* would require adding some attributes that lightweight implementations would
* not need. Subclasses may easily override this policy by calling this method
* and caching the result, but implementors are encouraged to write more
* efficient ad-hoc implementations.
*
* @return a set view of the values of this map; it may be safely cast to a
* type-specific interface.
*/
@Override
public ObjectCollection values() {
return new AbstractObjectCollection() {
@Override
public boolean contains(final Object k) {
return containsValue(k);
}
@Override
public int size() {
return AbstractLong2ObjectMap.this.size();
}
@Override
public void clear() {
AbstractLong2ObjectMap.this.clear();
}
@Override
public ObjectIterator iterator() {
return new ObjectIterator() {
private final ObjectIterator> i = Long2ObjectMaps
.fastIterator(AbstractLong2ObjectMap.this);
@Override
public V next() {
return i.next().getValue();
}
@Override
public boolean hasNext() {
return i.hasNext();
}
@Override
public void remove() {
i.remove();
}
@Override
public void forEachRemaining(final Consumer action) {
i.forEachRemaining(entry -> action.accept(entry.getValue()));
}
};
}
@Override
public ObjectSpliterator spliterator() {
return ObjectSpliterators.asSpliterator(iterator(), sizeOf(AbstractLong2ObjectMap.this),
ObjectSpliterators.COLLECTION_SPLITERATOR_CHARACTERISTICS);
}
};
}
/** {@inheritDoc} */
@SuppressWarnings({"unchecked", "deprecation"})
@Override
public void putAll(final Map m) {
if (m instanceof Long2ObjectMap) {
ObjectIterator> i = Long2ObjectMaps.fastIterator((Long2ObjectMap) m);
while (i.hasNext()) {
final Long2ObjectMap.Entry e = i.next();
put(e.getLongKey(), e.getValue());
}
} else {
int n = m.size();
final Iterator> i = m.entrySet().iterator();
Map.Entry e;
while (n-- != 0) {
e = i.next();
put(e.getKey(), e.getValue());
}
}
}
/**
* Returns a hash code for this map.
*
* The hash code of a map is computed by summing the hash codes of its entries.
*
* @return a hash code for this map.
*/
@Override
public int hashCode() {
int h = 0, n = size();
final ObjectIterator> i = Long2ObjectMaps.fastIterator(this);
while (n-- != 0)
h += i.next().hashCode();
return h;
}
@Override
public boolean equals(Object o) {
if (o == this)
return true;
if (!(o instanceof Map))
return false;
final Map m = (Map) o;
if (m.size() != size())
return false;
return long2ObjectEntrySet().containsAll(m.entrySet());
}
@Override
public String toString() {
final StringBuilder s = new StringBuilder();
final ObjectIterator> i = Long2ObjectMaps.fastIterator(this);
int n = size();
Long2ObjectMap.Entry e;
boolean first = true;
s.append("{");
while (n-- != 0) {
if (first)
first = false;
else
s.append(", ");
e = i.next();
s.append(String.valueOf(e.getLongKey()));
s.append("=>");
if (this == e.getValue())
s.append("(this map)");
else
s.append(String.valueOf(e.getValue()));
}
s.append("}");
return s.toString();
}
}