it.unimi.dsi.fastutil.ints.Int2CharSortedMaps Maven / Gradle / Ivy
Show all versions of fastutil Show documentation
/* Copyright (C) 1991-2016 Free Software Foundation, Inc.
This file is part of the GNU C Library.
The GNU C Library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
The GNU C Library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with the GNU C Library; if not, see
or any other header that includes
because the implicit include comes before any feature
test macros that may be defined in a source file before it first
explicitly includes a system header. GCC knows the name of this
header in order to preinclude it. */
/* glibc's intent is to support the IEC 559 math functionality, real
and complex. If the GCC (4.9 and later) predefined macros
specifying compiler intent are available, use them to determine
whether the overall intent is to support these features; otherwise,
presume an older compiler has intent to support these features and
define these macros by default. */
/* wchar_t uses Unicode 9.0.0. Version 9.0 of the Unicode Standard is
synchronized with ISO/IEC 10646:2014, fourth edition, plus
Amd. 1 and Amd. 2 and 273 characters from forthcoming 10646, fifth edition.
(Amd. 2 was published 2016-05-01,
see https://www.iso.org/obp/ui/#iso:std:iso-iec:10646:ed-4:v1:amd:2:v1:en) */
/* We do not support C11 . */
/* 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) */
/* Primitive-type-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.ints;
import it.unimi.dsi.fastutil.objects.ObjectSortedSet;
import it.unimi.dsi.fastutil.objects.ObjectSortedSets;
import java.util.Comparator;
import java.util.Map;
import java.util.SortedMap;
import java.util.NoSuchElementException;
/**
* A class providing static methods and objects that do useful things with
* type-specific sorted maps.
*
* @see java.util.Collections
*/
public class Int2CharSortedMaps {
private Int2CharSortedMaps() {
}
/**
* Returns a comparator for entries based on a given comparator on keys.
*
* @param comparator
* a comparator on keys.
* @return the associated comparator on entries.
*/
public static Comparator> entryComparator(final IntComparator comparator) {
return new Comparator>() {
public int compare(Map.Entry x, Map.Entry y) {
return comparator.compare(x.getKey(), y.getKey());
}
};
}
/**
* An immutable class representing an empty type-specific sorted map.
*
*
* This class may be useful to implement your own in case you subclass a
* type-specific sorted map.
*/
public static class EmptySortedMap extends Int2CharMaps.EmptyMap implements Int2CharSortedMap, java.io.Serializable, Cloneable {
private static final long serialVersionUID = -7046029254386353129L;
protected EmptySortedMap() {
}
public IntComparator comparator() {
return null;
}
@SuppressWarnings("unchecked")
public ObjectSortedSet int2CharEntrySet() {
return ObjectSortedSets.EMPTY_SET;
}
@SuppressWarnings("unchecked")
public ObjectSortedSet> entrySet() {
return ObjectSortedSets.EMPTY_SET;
}
public IntSortedSet keySet() {
return IntSortedSets.EMPTY_SET;
}
public Int2CharSortedMap subMap(final int from, final int to) {
return EMPTY_MAP;
}
public Int2CharSortedMap headMap(final int to) {
return EMPTY_MAP;
}
public Int2CharSortedMap tailMap(final int from) {
return EMPTY_MAP;
}
public int firstIntKey() {
throw new NoSuchElementException();
}
public int lastIntKey() {
throw new NoSuchElementException();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method
* instead.
*/
@Deprecated
public Int2CharSortedMap headMap(Integer oto) {
return headMap(((oto).intValue()));
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method
* instead.
*/
@Deprecated
public Int2CharSortedMap tailMap(Integer ofrom) {
return tailMap(((ofrom).intValue()));
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method
* instead.
*/
@Deprecated
public Int2CharSortedMap subMap(Integer ofrom, Integer oto) {
return subMap(((ofrom).intValue()), ((oto).intValue()));
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method
* instead.
*/
@Deprecated
public Integer firstKey() {
return (Integer.valueOf(firstIntKey()));
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method
* instead.
*/
@Deprecated
public Integer lastKey() {
return (Integer.valueOf(lastIntKey()));
}
}
/**
* An empty sorted map (immutable). It is serializable and cloneable.
*/
public static final EmptySortedMap EMPTY_MAP = new EmptySortedMap();
/**
* An immutable class representing a type-specific singleton sorted map.
*
*
* This class may be useful to implement your own in case you subclass a
* type-specific sorted map.
*/
public static class Singleton extends Int2CharMaps.Singleton implements Int2CharSortedMap, java.io.Serializable, Cloneable {
private static final long serialVersionUID = -7046029254386353129L;
protected final IntComparator comparator;
protected Singleton(final int key, final char value, IntComparator comparator) {
super(key, value);
this.comparator = comparator;
}
protected Singleton(final int key, final char value) {
this(key, value, null);
}
final int compare(final int k1, final int k2) {
return comparator == null ? (Integer.compare((k1), (k2))) : comparator.compare(k1, k2);
}
public IntComparator comparator() {
return comparator;
}
public ObjectSortedSet int2CharEntrySet() {
if (entries == null) entries = ObjectSortedSets.singleton((Int2CharMap.Entry) new SingletonEntry(), (Comparator) entryComparator(comparator));
return (ObjectSortedSet) entries;
}
@SuppressWarnings({ "rawtypes", "unchecked" })
public ObjectSortedSet> entrySet() {
return (ObjectSortedSet) int2CharEntrySet();
}
public IntSortedSet keySet() {
if (keys == null) keys = IntSortedSets.singleton(key, comparator);
return (IntSortedSet) keys;
}
public Int2CharSortedMap subMap(final int from, final int to) {
if (compare(from, key) <= 0 && compare(key, to) < 0) return this;
return EMPTY_MAP;
}
public Int2CharSortedMap headMap(final int to) {
if (compare(key, to) < 0) return this;
return EMPTY_MAP;
}
public Int2CharSortedMap tailMap(final int from) {
if (compare(from, key) <= 0) return this;
return EMPTY_MAP;
}
public int firstIntKey() {
return key;
}
public int lastIntKey() {
return key;
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method
* instead.
*/
@Deprecated
public Int2CharSortedMap headMap(Integer oto) {
return headMap(((oto).intValue()));
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method
* instead.
*/
@Deprecated
public Int2CharSortedMap tailMap(Integer ofrom) {
return tailMap(((ofrom).intValue()));
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method
* instead.
*/
@Deprecated
public Int2CharSortedMap subMap(Integer ofrom, Integer oto) {
return subMap(((ofrom).intValue()), ((oto).intValue()));
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method
* instead.
*/
@Deprecated
public Integer firstKey() {
return (Integer.valueOf(firstIntKey()));
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method
* instead.
*/
@Deprecated
public Integer lastKey() {
return (Integer.valueOf(lastIntKey()));
}
}
/**
* Returns a type-specific immutable sorted map containing only the
* specified pair. The returned sorted map is serializable and cloneable.
*
*
* Note that albeit the returned map is immutable, its default return value
* may be changed.
*
* @param key
* the only key of the returned sorted map.
* @param value
* the only value of the returned sorted map.
* @return a type-specific immutable sorted map containing just the pair
* <key,value>.
*/
public static Int2CharSortedMap singleton(final Integer key, Character value) {
return new Singleton(((key).intValue()), ((value).charValue()));
}
/**
* RETURNS a type-specific immutable sorted map containing only the
* specified pair. The returned sorted map is serializable and cloneable.
*
*
* Note that albeit the returned map is immutable, its default return value
* may be changed.
*
* @param key
* the only key of the returned sorted map.
* @param value
* the only value of the returned sorted map.
* @param comparator
* the comparator to use in the returned sorted map.
* @return a type-specific immutable sorted map containing just the pair
* <key,value>.
*/
public static Int2CharSortedMap singleton(final Integer key, Character value, IntComparator comparator) {
return new Singleton(((key).intValue()), ((value).charValue()), comparator);
}
/**
* Returns a type-specific immutable sorted map containing only the
* specified pair. The returned sorted map is serializable and cloneable.
*
*
* Note that albeit the returned map is immutable, its default return value
* may be changed.
*
* @param key
* the only key of the returned sorted map.
* @param value
* the only value of the returned sorted map.
* @return a type-specific immutable sorted map containing just the pair
* <key,value>.
*/
public static Int2CharSortedMap singleton(final int key, final char value) {
return new Singleton(key, value);
}
/**
* Returns a type-specific immutable sorted map containing only the
* specified pair. The returned sorted map is serializable and cloneable.
*
*
* Note that albeit the returned map is immutable, its default return value
* may be changed.
*
* @param key
* the only key of the returned sorted map.
* @param value
* the only value of the returned sorted map.
* @param comparator
* the comparator to use in the returned sorted map.
* @return a type-specific immutable sorted map containing just the pair
* <key,value>.
*/
public static Int2CharSortedMap singleton(final int key, final char value, IntComparator comparator) {
return new Singleton(key, value, comparator);
}
/** A synchronized wrapper class for sorted maps. */
public static class SynchronizedSortedMap extends Int2CharMaps.SynchronizedMap implements Int2CharSortedMap, java.io.Serializable {
private static final long serialVersionUID = -7046029254386353129L;
protected final Int2CharSortedMap sortedMap;
protected SynchronizedSortedMap(final Int2CharSortedMap m, final Object sync) {
super(m, sync);
sortedMap = m;
}
protected SynchronizedSortedMap(final Int2CharSortedMap m) {
super(m);
sortedMap = m;
}
public IntComparator comparator() {
synchronized (sync) {
return sortedMap.comparator();
}
}
public ObjectSortedSet int2CharEntrySet() {
if (entries == null) entries = ObjectSortedSets.synchronize(sortedMap.int2CharEntrySet(), sync);
return (ObjectSortedSet) entries;
}
@SuppressWarnings({ "rawtypes", "unchecked" })
public ObjectSortedSet> entrySet() {
return (ObjectSortedSet) int2CharEntrySet();
}
public IntSortedSet keySet() {
if (keys == null) keys = IntSortedSets.synchronize(sortedMap.keySet(), sync);
return (IntSortedSet) keys;
}
public Int2CharSortedMap subMap(final int from, final int to) {
return new SynchronizedSortedMap(sortedMap.subMap(from, to), sync);
}
public Int2CharSortedMap headMap(final int to) {
return new SynchronizedSortedMap(sortedMap.headMap(to), sync);
}
public Int2CharSortedMap tailMap(final int from) {
return new SynchronizedSortedMap(sortedMap.tailMap(from), sync);
}
public int firstIntKey() {
synchronized (sync) {
return sortedMap.firstIntKey();
}
}
public int lastIntKey() {
synchronized (sync) {
return sortedMap.lastIntKey();
}
}
public Integer firstKey() {
synchronized (sync) {
return sortedMap.firstKey();
}
}
public Integer lastKey() {
synchronized (sync) {
return sortedMap.lastKey();
}
}
public Int2CharSortedMap subMap(final Integer from, final Integer to) {
return new SynchronizedSortedMap(sortedMap.subMap(from, to), sync);
}
public Int2CharSortedMap headMap(final Integer to) {
return new SynchronizedSortedMap(sortedMap.headMap(to), sync);
}
public Int2CharSortedMap tailMap(final Integer from) {
return new SynchronizedSortedMap(sortedMap.tailMap(from), sync);
}
}
/**
* Returns a synchronized type-specific sorted map backed by the given
* type-specific sorted map.
*
* @param m
* the sorted map to be wrapped in a synchronized sorted map.
* @return a synchronized view of the specified sorted map.
* @see java.util.Collections#synchronizedSortedMap(SortedMap)
*/
public static Int2CharSortedMap synchronize(final Int2CharSortedMap m) {
return new SynchronizedSortedMap(m);
}
/**
* Returns a synchronized type-specific sorted map backed by the given
* type-specific sorted map, using an assigned object to synchronize.
*
* @param m
* the sorted map to be wrapped in a synchronized sorted map.
* @param sync
* an object that will be used to synchronize the access to the
* sorted sorted map.
* @return a synchronized view of the specified sorted map.
* @see java.util.Collections#synchronizedSortedMap(SortedMap)
*/
public static Int2CharSortedMap synchronize(final Int2CharSortedMap m, final Object sync) {
return new SynchronizedSortedMap(m, sync);
}
/** An unmodifiable wrapper class for sorted maps. */
public static class UnmodifiableSortedMap extends Int2CharMaps.UnmodifiableMap implements Int2CharSortedMap, java.io.Serializable {
private static final long serialVersionUID = -7046029254386353129L;
protected final Int2CharSortedMap sortedMap;
protected UnmodifiableSortedMap(final Int2CharSortedMap m) {
super(m);
sortedMap = m;
}
public IntComparator comparator() {
return sortedMap.comparator();
}
public ObjectSortedSet int2CharEntrySet() {
if (entries == null) entries = ObjectSortedSets.unmodifiable(sortedMap.int2CharEntrySet());
return (ObjectSortedSet) entries;
}
@SuppressWarnings({ "rawtypes", "unchecked" })
public ObjectSortedSet> entrySet() {
return (ObjectSortedSet) int2CharEntrySet();
}
public IntSortedSet keySet() {
if (keys == null) keys = IntSortedSets.unmodifiable(sortedMap.keySet());
return (IntSortedSet) keys;
}
public Int2CharSortedMap subMap(final int from, final int to) {
return new UnmodifiableSortedMap(sortedMap.subMap(from, to));
}
public Int2CharSortedMap headMap(final int to) {
return new UnmodifiableSortedMap(sortedMap.headMap(to));
}
public Int2CharSortedMap tailMap(final int from) {
return new UnmodifiableSortedMap(sortedMap.tailMap(from));
}
public int firstIntKey() {
return sortedMap.firstIntKey();
}
public int lastIntKey() {
return sortedMap.lastIntKey();
}
public Integer firstKey() {
return sortedMap.firstKey();
}
public Integer lastKey() {
return sortedMap.lastKey();
}
public Int2CharSortedMap subMap(final Integer from, final Integer to) {
return new UnmodifiableSortedMap(sortedMap.subMap(from, to));
}
public Int2CharSortedMap headMap(final Integer to) {
return new UnmodifiableSortedMap(sortedMap.headMap(to));
}
public Int2CharSortedMap tailMap(final Integer from) {
return new UnmodifiableSortedMap(sortedMap.tailMap(from));
}
}
/**
* Returns an unmodifiable type-specific sorted map backed by the given
* type-specific sorted map.
*
* @param m
* the sorted map to be wrapped in an unmodifiable sorted map.
* @return an unmodifiable view of the specified sorted map.
* @see java.util.Collections#unmodifiableSortedMap(SortedMap)
*/
public static Int2CharSortedMap unmodifiable(final Int2CharSortedMap m) {
return new UnmodifiableSortedMap(m);
}
}