http://fastutil.di.unimi.it/: 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, sorting algorithms, and fast, practical I/O classes for binary and text files.
  • Sebastiano Vigna 
/*
 * Copyright (C) 2002-2020 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;

import it.unimi.dsi.fastutil.objects.ObjectObjectImmutablePair;
import it.unimi.dsi.fastutil.objects.ObjectObjectImmutableSortedPair;


A pair of sorted elements.

 This interface strengthen Pair, without adding methods. It assumes that both elements of the pair are of the same type, and that they are primitive or comparable. It guarantees that the left element is smaller than or equal to the right
element. 

Implementations of this class can be used to represent unordered pairs by
canonicalization. Note that, in particular, if you build a sorted pair using a left and right
element in the wrong order they will be exchanged.

Type parameters:
  • <K> – the type of the elements.
/**
 * A pair of sorted elements.
 *
 * <p>
 * This interface strengthen {@link Pair}, without adding methods. It assumes that both elements of
 * the pair are of the same type, and that they are primitive or comparable. It guarantees that the
 * {@linkplain #left() left element} is smaller than or equal to the {@linkplain #right() right
 * element}.
 *
 * <p>
 * Implementations of this class can be used to represent <em>unordered pairs</em> by
 * canonicalization. Note that, in particular, if you build a sorted pair using a left and right
 * element in the wrong order they will be exchanged.
 *
 * @param <K> the type of the elements.
 */

public interface SortedPair<K extends Comparable<K>> extends Pair<K, K> {

	
Returns a new immutable SortedPair with given left and right value. 
 Note that if left and right are in the wrong order, they will be exchanged. 
Params:
  • l – the left value.
  • r – the right value.
Implementation Note:This factory method delegates to ObjectObjectImmutablePair.of(Object, Object).
/**
	 * Returns a new immutable {@link it.unimi.dsi.fastutil.SortedPair SortedPair} with given left
	 * and right value.
	 *
	 * <p>
	 * Note that if {@code left} and {@code right} are in the wrong order, they will be exchanged.
	 *
	 * @param l the left value.
	 * @param r the right value.
	 *
	 * @implNote This factory method delegates to
	 *           {@link ObjectObjectImmutablePair#of(Object, Object)}.
	 */
	public static <K extends Comparable<K>> SortedPair<K> of(final K l, final K r) {
		return ObjectObjectImmutableSortedPair.of(l, r);
	}
}