Tweaking

vigna · vigna · commit 9b62a5a1b6c0 · 2022-02-10T14:45:44.000+01:00
diff --git a/README.md b/README.md
@@ -1,16 +1,11 @@
 # Welcome to fastutil
 
-[fastutil](http://fastutil.di.unimi.it/) is a collection of type-specific
-Java classes that extend the Java Collections Framework by providing
-several containers, such as maps, sets, lists and prority queues,
-implementing the interfaces of the java.util package; it also provides big
-(64-bit) arrays, sets, lists, and fast, practical I/O classes for binary
-and text files.
-
-fastutil provides a huge collection of specialized classes generated
-starting from a parameterized version; the classes are much more compact
-and much faster than the general ones. Please read the package
-documentation for more information.
+[fastutil](http://fastutil.di.unimi.it/) extends the Java Collections
+Framework by providing type-specific maps, sets, lists, and queues with a
+small memory footprint and fast access and insertion; it provides also big
+(64-bit) arrays, sets, and lists, sorting algorithms, fast, practical I/O
+classes for binary and text files, and facilities for memory mapping large
+files.
 
 Since version 8.5.5, fastutil is split into two jars for convenience:
 
diff --git a/drv/AbstractBidirectionalIterator.drv b/drv/AbstractBidirectionalIterator.drv
@@ -19,7 +19,7 @@ package PACKAGE;
 
 /**  An abstract class facilitating the creation of type-specific {@linkplain it.unimi.dsi.fastutil.BidirectionalIterator bidirectional iterators}.
  *
- * @deprecated As of fastutil 8 this class is no longer necessary, as its previous abstract
+ * @deprecated As of {@code fastutil} 8 this class is no longer necessary, as its previous abstract
  * methods are now default methods of the type-specific interface.
  */
 
diff --git a/drv/AbstractBigListIterator.drv b/drv/AbstractBigListIterator.drv
@@ -19,7 +19,7 @@ package PACKAGE;
 
 /**  An abstract class facilitating the creation of type-specific {@linkplain it.unimi.dsi.fastutil.BigListIterator big-list iterators}.
  *
- * @deprecated As of fastutil 8 this class is no longer necessary, as its previous abstract
+ * @deprecated As of {@code fastutil} 8 this class is no longer necessary, as its previous abstract
  * methods are now default methods of the type-specific interface.
  */
 
diff --git a/drv/AbstractComparator.drv b/drv/AbstractComparator.drv
@@ -20,7 +20,7 @@ package PACKAGE;
 /**  An abstract class facilitating the creation of type-specific {@linkplain java.util.Comparator comparators}.
  *
  * @see java.util.Comparator
- * @deprecated As of fastutil 8 this class is no longer necessary, as its only previous abstract
+ * @deprecated As of {@code fastutil} 8 this class is no longer necessary, as its only previous abstract
  * method is now a default method of the type-specific interface.
  */
 
diff --git a/drv/AbstractListIterator.drv b/drv/AbstractListIterator.drv
@@ -19,7 +19,7 @@ package PACKAGE;
 
 /**  An abstract class facilitating the creation of type-specific {@linkplain java.util.ListIterator list iterators}.
  *
- * @deprecated As of fastutil 8 this class is no longer necessary, as its previous abstract
+ * @deprecated As of {@code fastutil} 8 this class is no longer necessary, as its previous abstract
  * methods are now default methods of the type-specific interface.
  */
 
diff --git a/drv/AbstractPriorityQueue.drv b/drv/AbstractPriorityQueue.drv
@@ -18,7 +18,7 @@
 package PACKAGE;
 
 /**  An abstract class providing basic methods for priority queues implementing a type-specific interface.
- * @deprecated As of fastutil 8 this class is no longer necessary, as its previous abstract
+ * @deprecated As of {@code fastutil} 8 this class is no longer necessary, as its previous abstract
  * methods are now default methods of the type-specific interface.
  */
 @Deprecated
diff --git a/drv/AbstractStack.drv b/drv/AbstractStack.drv
@@ -19,7 +19,7 @@ package PACKAGE;
 
 /** An abstract class providing basic methods for implementing a type-specific stack interface.
  *
- * @deprecated As of fastutil 8 this class is no longer necessary, as its previous abstract
+ * @deprecated As of {@code fastutil} 8 this class is no longer necessary, as its previous abstract
  * methods are now default methods of the type-specific interface.
  */
 @Deprecated
diff --git a/drv/Arrays.drv b/drv/Arrays.drv
@@ -1237,8 +1237,8 @@ public final class ARRAYS {
 	 *
 	 * <p>This method implements a <em>lexicographical</em> sorting of the arguments. Pairs of
 	 * elements in the same position in the two provided arrays will be considered a single key, and
-	 * permuted accordingly. In the end, either {@code x[i] &lt; x[i + 1]} or <code>x[i]
-	 * == x[i + 1]</code> and {@code y[i] &le; y[i + 1]}.
+	 * permuted accordingly. In the end, either {@code x[i] &lt; x[i + 1]} or {@code x[i]
+	 * == x[i + 1]} and {@code y[i] &le; y[i + 1]}.
 	 *
 	 * @param x the first array to be sorted.
 	 * @param y the second array to be sorted.
@@ -1299,8 +1299,8 @@ public final class ARRAYS {
 	 *
 	 * <p>This method implements a <em>lexicographical</em> sorting of the arguments. Pairs of
 	 * elements in the same position in the two provided arrays will be considered a single key, and
-	 * permuted accordingly. In the end, either {@code x[i] &lt; x[i + 1]} or <code>x[i]
-	 * == x[i + 1]</code> and {@code y[i] &le; y[i + 1]}.
+	 * permuted accordingly. In the end, either {@code x[i] &lt; x[i + 1]} or {@code x[i]
+	 * == x[i + 1]} and {@code y[i] &le; y[i + 1]}.
 	 *
 	 * @param x the first array to be sorted.
 	 * @param y the second array to be sorted.
@@ -1382,8 +1382,8 @@ public final class ARRAYS {
 	 *
 	 * <p>This method implements a <em>lexicographical</em> sorting of the arguments. Pairs of
 	 * elements in the same position in the two provided arrays will be considered a single key, and
-	 * permuted accordingly. In the end, either {@code x[i] &lt; x[i + 1]} or <code>x[i]
-	 * == x[i + 1]</code> and {@code y[i] &le; y[i + 1]}.
+	 * permuted accordingly. In the end, either {@code x[i] &lt; x[i + 1]} or {@code x[i]
+	 * == x[i + 1]} and {@code y[i] &le; y[i + 1]}.
 	 *
 	 * @param x the first array to be sorted.
 	 * @param y the second array to be sorted.
@@ -1407,8 +1407,8 @@ public final class ARRAYS {
 	 *
 	 * <p>This method implements a <em>lexicographical</em> sorting of the arguments. Pairs of
 	 * elements in the same position in the two provided arrays will be considered a single key, and
-	 * permuted accordingly. In the end, either {@code x[i] &lt; x[i + 1]} or <code>x[i]
-	 * == x[i + 1]</code> and {@code y[i] &le; y[i + 1]}.
+	 * permuted accordingly. In the end, either {@code x[i] &lt; x[i + 1]} or {@code x[i]
+	 * == x[i + 1]} and {@code y[i] &le; y[i + 1]}.
 	 *
 	 * @param x the first array to be sorted.
 	 * @param y the second array to be sorted.
diff --git a/drv/BinIOFragment.drv b/drv/BinIOFragment.drv
@@ -597,8 +597,8 @@ public static void STORE_KEYS(final KEY_TYPE array[], final CharSequence filenam
  * @param channel a readable channel.
  * @param byteOrder the byte order of the data from {@code channel}.
  * @param array a big array which will be filled with data from {@code channel}.
- * @param offset the index of the first element of {@code bigArray} to be filled.
- * @param length the number of elements of {@code bigArray} to be filled.
+ * @param offset the index of the first element of {@code array} to be filled.
+ * @param length the number of elements of {@code array} to be filled.
  * @return the number of elements actually read from {@code channel} (it might be less than {@code length} if {@code channel} ends).
  */
 public static long LOAD_KEYS(final ReadableByteChannel channel, final ByteOrder byteOrder, final KEY_TYPE[][] array, final long offset, final long length) throws IOException {
@@ -1174,8 +1174,8 @@ public static void STORE_KEYS(final KEY_TYPE array[], final CharSequence filenam
  *
  * @param dataInput a data input.
  * @param array a big array which will be filled with data from {@code dataInput}.
- * @param offset the index of the first element of {@code bigArray} to be filled.
- * @param length the number of elements of {@code bigArray} to be filled.
+ * @param offset the index of the first element of {@code array} to be filled.
+ * @param length the number of elements of {@code array} to be filled.
  * @return the number of elements actually read from {@code dataInput} (it might be less than {@code length} if {@code dataInput} ends).
  */
 public static long LOAD_KEYS(final DataInput dataInput, final KEY_TYPE[][] array, final long offset, final long length) throws IOException {
diff --git a/drv/List.drv b/drv/List.drv
@@ -208,14 +208,14 @@ public interface LIST KEY_GENERIC extends List<KEY_GENERIC_CLASS>, COLLECTION KE
 	/** Set (hopefully quickly) elements to match the array given.
 	 *
 	 * Sets each in this list to the corresponding elements in the array, as if by
-	 * <pre><code>
+	 * <pre>
 	 * ListIterator iter = listIterator(index);
 	 * int i = 0;
 	 * while (i &lt; length) {
 	 *   iter.next();
 	 *   iter.set(a[offset + i++]);
 	 * }
-	 * </code></pre>
+	 * </pre>
 	 * However, the exact implementation may be more efficient, taking into account
 	 * whether random access is faster or not, or at the discretion of subclasses,
 	 * abuse internals.
diff --git a/drv/Map.drv b/drv/Map.drv
@@ -112,7 +112,7 @@ public interface MAP KEY_VALUE_GENERIC extends FUNCTION KEY_VALUE_GENERIC, Map<K
 	/** Removes all of the mappings from this map (optional operation).
 	 * The map will be empty after this call returns.
 	 *
-	 * @throws UnsupportedOperationException if the <code>clear()</code> operation is not supported by this map
+	 * @throws UnsupportedOperationException if the {@link #clear()} operation is not supported by this map
 	 */
 
 	@Override
@@ -509,7 +509,7 @@ public interface MAP KEY_VALUE_GENERIC extends FUNCTION KEY_VALUE_GENERIC, Map<K
 	 * in the given mapping function.
 	 *
 	 * <p>This version of {@linkplain java.util.Map#computeIfAbsent(Object, java.util.function.Function) computeIfAbsent()}
-	 * uses a type-specific version of <code>fastutil</code>'s {@link it.unimi.dsi.fastutil.Function Function}.
+	 * uses a type-specific version of {@code fastutil}'s {@link it.unimi.dsi.fastutil.Function Function}.
 	 * Since {@link it.unimi.dsi.fastutil.Function Function} has a {@link it.unimi.dsi.fastutil.Function#containsKey(Object) containsKey()}
 	 * method, it is possible to avoid adding a key by having {@code containsKey()} return {@code false} for that key.
 	 *
diff --git a/drv/Stack.drv b/drv/Stack.drv
@@ -44,7 +44,7 @@ public interface STACK KEY_GENERIC extends Stack<KEY_GENERIC_CLASS> {
 
 	/** Peeks at an element on the stack (optional operation).
 	 * @param i an index from the stop of the stack (0 represents the top).
-	 * @return the <code>i</code>-th element on the stack.
+	 * @return the {@code i}-th element on the stack.
 	 * @see Stack#peek(int)
 	 */
 	KEY_TYPE PEEK(int i);
diff --git a/pom-core-model.xml b/pom-core-model.xml
@@ -5,7 +5,7 @@
   <packaging>jar</packaging>
   <name>fastutil</name>
   <version>@VERSION@</version>
-  <description>fastutil extends the Java Collections Framework by providing type-specific maps, sets, lists and priority queues with a small memory footprint and fast operations; it provides also big (64-bit) arrays, sets and lists, sorting algorithms, and fast, practical I/O classes for binary and text files. This jar (fastutil-core.jar) contains data structures based on integers, longs, doubles, and objects, only; fastutil.jar contains all classes. If you have both jars in your dependencies, this jar should be excluded.</description>
+  <description>fastutil extends the Java Collections Framework by providing type-specific maps, sets, lists, and queues with a small memory footprint and fast operations; it provides also big (64-bit) arrays, sets, and lists, sorting algorithms, fast, practical I/O classes for binary and text files, and facilities for memory mapping large files. This jar (fastutil-core.jar) contains data structures based on integers, longs, doubles, and objects, only; fastutil.jar contains all classes. If you have both jars in your dependencies, this jar should be excluded.</description>
   <url>http://fastutil.di.unimi.it/</url>
   <licenses>
     <license>
diff --git a/pom-model.xml b/pom-model.xml
@@ -5,7 +5,7 @@
   <packaging>jar</packaging>
   <name>fastutil</name>
   <version>@VERSION@</version>
-  <description>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. Note that if you have both this jar and fastutil-core.jar in your dependencies, fastutil-core.jar should be excluded.</description>
+  <description>fastutil extends the Java Collections Framework by providing type-specific maps, sets, lists, and queues with a small memory footprint and fast access and insertion; it provides also big (64-bit) arrays, sets and lists, sorting algorithms, fast, practical I/O classes for binary and text files, and facilities for memory mapping large files. Note that if you have both this jar and fastutil-core.jar in your dependencies, fastutil-core.jar should be excluded.</description>
   <url>http://fastutil.di.unimi.it/</url>
   <licenses>
     <license>
diff --git a/src/it/unimi/dsi/fastutil/AbstractIndirectPriorityQueue.java b/src/it/unimi/dsi/fastutil/AbstractIndirectPriorityQueue.java
@@ -18,7 +18,7 @@
 
 /** An abstract class providing basic methods for implementing the {@link IndirectPriorityQueue} interface.
  *
- * @deprecated As of fastutil 8 this class is no longer necessary, as its previous abstract
+ * @deprecated As of {@code fastutil} 8 this class is no longer necessary, as its previous abstract
  * methods are now default methods of {@link IndirectPriorityQueue}.
  */
 @Deprecated
diff --git a/src/it/unimi/dsi/fastutil/AbstractPriorityQueue.java b/src/it/unimi/dsi/fastutil/AbstractPriorityQueue.java
@@ -18,7 +18,7 @@
 
 /**  An abstract class providing basic methods for implementing the {@link PriorityQueue} interface.
  *
- * @deprecated As of fastutil 8 this class is no longer necessary, as its previous abstract
+ * @deprecated As of {@code fastutil} 8 this class is no longer necessary, as its previous abstract
  * methods are now default methods of {@link PriorityQueue}.
  */
 @Deprecated
diff --git a/src/it/unimi/dsi/fastutil/AbstractStack.java b/src/it/unimi/dsi/fastutil/AbstractStack.java
@@ -18,7 +18,7 @@
 
 /** An abstract class providing basic methods for implementing the {@link Stack} interface.
   *
- * @deprecated As of fastutil 8 this class is no longer necessary, as its previous abstract
+ * @deprecated As of {@code fastutil} 8 this class is no longer necessary, as its previous abstract
  * methods are now default methods of {@link Stack}.
  */
 @Deprecated

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ package PACKAGE;`
`19`	`19`
`20`	`20`	`/** An abstract class facilitating the creation of type-specific {@linkplain it.unimi.dsi.fastutil.BidirectionalIterator bidirectional iterators}.`
`21`	`21`	`*`
`22`		`- * @deprecated As of fastutil 8 this class is no longer necessary, as its previous abstract`
	`22`	`+ * @deprecated As of {@code fastutil} 8 this class is no longer necessary, as its previous abstract`
`23`	`23`	`* methods are now default methods of the type-specific interface.`
`24`	`24`	`*/`
`25`	`25`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ package PACKAGE;`
`20`	`20`	`/** An abstract class facilitating the creation of type-specific {@linkplain java.util.Comparator comparators}.`
`21`	`21`	`*`
`22`	`22`	`* @see java.util.Comparator`
`23`		`- * @deprecated As of fastutil 8 this class is no longer necessary, as its only previous abstract`
	`23`	`+ * @deprecated As of {@code fastutil} 8 this class is no longer necessary, as its only previous abstract`
`24`	`24`	`* method is now a default method of the type-specific interface.`
`25`	`25`	`*/`
`26`	`26`
Original file line number	Diff line number	Diff line change
`@@ -1237,8 +1237,8 @@ public final class ARRAYS {`
`1237`	`1237`	`*`
`1238`	`1238`	`* <p>This method implements a <em>lexicographical</em> sorting of the arguments. Pairs of`
`1239`	`1239`	`* elements in the same position in the two provided arrays will be considered a single key, and`
`1240`		`- * permuted accordingly. In the end, either {@code x[i] < x[i + 1]} or <code>x[i]`
`1241`		`- * == x[i + 1]</code> and {@code y[i] ≤ y[i + 1]}.`
	`1240`	`+ * permuted accordingly. In the end, either {@code x[i] < x[i + 1]} or {@code x[i]`
	`1241`	`+ * == x[i + 1]} and {@code y[i] ≤ y[i + 1]}.`
`1242`	`1242`	`*`
`1243`	`1243`	`* @param x the first array to be sorted.`
`1244`	`1244`	`* @param y the second array to be sorted.`
`@@ -1299,8 +1299,8 @@ public final class ARRAYS {`
`1299`	`1299`	`*`
`1300`	`1300`	`* <p>This method implements a <em>lexicographical</em> sorting of the arguments. Pairs of`
`1301`	`1301`	`* elements in the same position in the two provided arrays will be considered a single key, and`
`1302`		`- * permuted accordingly. In the end, either {@code x[i] < x[i + 1]} or <code>x[i]`
`1303`		`- * == x[i + 1]</code> and {@code y[i] ≤ y[i + 1]}.`
	`1302`	`+ * permuted accordingly. In the end, either {@code x[i] < x[i + 1]} or {@code x[i]`
	`1303`	`+ * == x[i + 1]} and {@code y[i] ≤ y[i + 1]}.`
`1304`	`1304`	`*`
`1305`	`1305`	`* @param x the first array to be sorted.`
`1306`	`1306`	`* @param y the second array to be sorted.`
`@@ -1382,8 +1382,8 @@ public final class ARRAYS {`
`1382`	`1382`	`*`
`1383`	`1383`	`* <p>This method implements a <em>lexicographical</em> sorting of the arguments. Pairs of`
`1384`	`1384`	`* elements in the same position in the two provided arrays will be considered a single key, and`
`1385`		`- * permuted accordingly. In the end, either {@code x[i] < x[i + 1]} or <code>x[i]`
`1386`		`- * == x[i + 1]</code> and {@code y[i] ≤ y[i + 1]}.`
	`1385`	`+ * permuted accordingly. In the end, either {@code x[i] < x[i + 1]} or {@code x[i]`
	`1386`	`+ * == x[i + 1]} and {@code y[i] ≤ y[i + 1]}.`
`1387`	`1387`	`*`
`1388`	`1388`	`* @param x the first array to be sorted.`
`1389`	`1389`	`* @param y the second array to be sorted.`
`@@ -1407,8 +1407,8 @@ public final class ARRAYS {`
`1407`	`1407`	`*`
`1408`	`1408`	`* <p>This method implements a <em>lexicographical</em> sorting of the arguments. Pairs of`
`1409`	`1409`	`* elements in the same position in the two provided arrays will be considered a single key, and`
`1410`		`- * permuted accordingly. In the end, either {@code x[i] < x[i + 1]} or <code>x[i]`
`1411`		`- * == x[i + 1]</code> and {@code y[i] ≤ y[i + 1]}.`
	`1410`	`+ * permuted accordingly. In the end, either {@code x[i] < x[i + 1]} or {@code x[i]`
	`1411`	`+ * == x[i + 1]} and {@code y[i] ≤ y[i + 1]}.`
`1412`	`1412`	`*`
`1413`	`1413`	`* @param x the first array to be sorted.`
`1414`	`1414`	`* @param y the second array to be sorted.`
Original file line number	Diff line number	Diff line change
`@@ -112,7 +112,7 @@ public interface MAP KEY_VALUE_GENERIC extends FUNCTION KEY_VALUE_GENERIC, Map<K`
`112`	`112`	`/** Removes all of the mappings from this map (optional operation).`
`113`	`113`	`* The map will be empty after this call returns.`
`114`	`114`	`*`
`115`		`- * @throws UnsupportedOperationException if the <code>clear()</code> operation is not supported by this map`
	`115`	`+ * @throws UnsupportedOperationException if the {@link #clear()} operation is not supported by this map`
`116`	`116`	`*/`
`117`	`117`
`118`	`118`	`@Override`
`@@ -509,7 +509,7 @@ public interface MAP KEY_VALUE_GENERIC extends FUNCTION KEY_VALUE_GENERIC, Map<K`
`509`	`509`	`* in the given mapping function.`
`510`	`510`	`*`
`511`	`511`	`* <p>This version of {@linkplain java.util.Map#computeIfAbsent(Object, java.util.function.Function) computeIfAbsent()}`
`512`		`- * uses a type-specific version of <code>fastutil</code>'s {@link it.unimi.dsi.fastutil.Function Function}.`
	`512`	`+ * uses a type-specific version of {@code fastutil}'s {@link it.unimi.dsi.fastutil.Function Function}.`
`513`	`513`	`* Since {@link it.unimi.dsi.fastutil.Function Function} has a {@link it.unimi.dsi.fastutil.Function#containsKey(Object) containsKey()}`
`514`	`514`	`* method, it is possible to avoid adding a key by having {@code containsKey()} return {@code false} for that key.`
`515`	`515`	`*`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@`
`18`	`18`
`19`	`19`	`/** An abstract class providing basic methods for implementing the {@link IndirectPriorityQueue} interface.`
`20`	`20`	`*`
`21`		`- * @deprecated As of fastutil 8 this class is no longer necessary, as its previous abstract`
	`21`	`+ * @deprecated As of {@code fastutil} 8 this class is no longer necessary, as its previous abstract`
`22`	`22`	`* methods are now default methods of {@link IndirectPriorityQueue}.`
`23`	`23`	`*/`
`24`	`24`	`@Deprecated`