it.unimi.dsi.fastutil.shorts.Short2ReferenceFunction 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) */
/*
* 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.shorts;
import it.unimi.dsi.fastutil.Function;
/**
* A type-specific {@link Function}; provides some additional methods that use
* polymorphism to avoid (un)boxing.
*
*
* Type-specific versions of get(), put() and
* remove() cannot rely on null to denote absence of a
* key. Rather, they return a {@linkplain #defaultReturnValue() default return
* value}, which is set to 0 cast to the return type (false for
* booleans) at creation, but can be changed using the
* defaultReturnValue() method.
*
*
* For uniformity reasons, even maps returning objects implement the default
* return value (of course, in this case the default return value is initialized
* to null).
*
*
* Warning: to fall in line as much as possible with the
* {@linkplain java.util.Map standard map interface}, it is strongly suggested
* that standard versions of get(), put() and
* remove() for maps with primitive-type values return
* null to denote missing keys rather than wrap the default
* return value in an object (of course, for maps with object keys and values
* this is not possible, as there is no type-specific version).
*
* @see Function
*/
public interface Short2ReferenceFunction extends Function {
/**
* Adds a pair to the map.
*
* @param key
* the key.
* @param value
* the value.
* @return the old value, or the {@linkplain #defaultReturnValue() default
* return value} if no value was present for the given key.
* @see Function#put(Object,Object)
*/
V put(short key, V value);
/**
* Returns the value to which the given key is mapped.
*
* @param key
* the key.
* @return the corresponding value, or the {@linkplain #defaultReturnValue()
* default return value} if no value was present for the given key.
* @see Function#get(Object)
*/
V get(short key);
/**
* Removes the mapping with the given key.
*
* @param key
* the key.
* @return the old value, or the {@linkplain #defaultReturnValue() default
* return value} if no value was present for the given key.
* @see Function#remove(Object)
*/
V remove(short key);
/**
* @see Function#containsKey(Object)
*/
boolean containsKey(short key);
/**
* Sets the default return value.
*
* This value must be returned by type-specific versions of
* get(), put() and remove() to
* denote that the map does not contain the specified key. It must be
* 0/false/null by default.
*
* @param rv
* the new default return value.
* @see #defaultReturnValue()
*/
void defaultReturnValue(V rv);
/**
* Gets the default return value.
*
* @return the current default return value.
*/
V defaultReturnValue();
}