This is an automated email from the git hooks/post-receive script. New commit to branch develop in repository nuiton-matrix. See https://gitlab.nuiton.org/nuiton/nuiton-matrix.git commit bd4e20d1819b09f5345db4e2d7909c75e309abcb Author: CHRE <CHATELLIER@codelutin.com> Date: Tue Aug 9 18:22:51 2016 +0200 Fix javadoc --- .../math/matrix/viewer/MatrixDimensionPanel.java | 3 +- .../src/main/java/cern/colt/GenericSorting.java | 14 +++++---- .../java/cern/colt/list/AbstractDoubleList.java | 2 +- .../main/java/cern/colt/list/AbstractLongList.java | 30 ++++++++++---------- .../main/java/cern/colt/list/ByteArrayList.java | 23 ++++++++------- .../main/java/cern/colt/list/DoubleArrayList.java | 14 ++++----- .../main/java/cern/colt/list/FloatArrayList.java | 14 ++++----- .../src/main/java/cern/colt/list/IntArrayList.java | 32 ++++++++++++--------- .../main/java/cern/colt/list/LongArrayList.java | 33 +++++++++++++--------- .../main/java/cern/colt/list/ObjectArrayList.java | 32 ++++++++++----------- .../java/cern/colt/map/AbstractDoubleIntMap.java | 4 +-- .../java/cern/colt/map/AbstractIntDoubleMap.java | 4 +-- .../main/java/cern/colt/map/AbstractIntIntMap.java | 4 +-- .../java/cern/colt/map/AbstractIntObjectMap.java | 6 ++-- .../java/cern/colt/map/AbstractLongObjectMap.java | 10 +++---- .../src/main/java/cern/colt/map/AbstractMap.java | 12 ++++---- .../java/cern/colt/map/OpenDoubleIntHashMap.java | 12 ++++---- .../java/cern/colt/map/OpenIntDoubleHashMap.java | 12 ++++---- .../main/java/cern/colt/map/OpenIntIntHashMap.java | 10 +++---- .../java/cern/colt/map/OpenIntObjectHashMap.java | 12 ++++---- .../java/cern/colt/map/OpenLongObjectHashMap.java | 12 ++++---- .../java/cern/colt/map/QuickOpenIntIntHashMap.java | 6 ++-- .../org/nuiton/math/matrix/AbstractMatrixND.java | 2 +- 23 files changed, 158 insertions(+), 145 deletions(-) diff --git a/nuiton-matrix-gui/src/main/java/org/nuiton/math/matrix/viewer/MatrixDimensionPanel.java b/nuiton-matrix-gui/src/main/java/org/nuiton/math/matrix/viewer/MatrixDimensionPanel.java index bfb6443..b6def11 100644 --- a/nuiton-matrix-gui/src/main/java/org/nuiton/math/matrix/viewer/MatrixDimensionPanel.java +++ b/nuiton-matrix-gui/src/main/java/org/nuiton/math/matrix/viewer/MatrixDimensionPanel.java @@ -155,10 +155,9 @@ public class MatrixDimensionPanel extends JPanel implements PropertyChangeListen } }; - /** + /* * Gere a la main le group de bouton, car sinon, lors que le premier * bouton est sélectionné, on ne peut pas le deselection - * protected List<JToggleButton> buttonList = new ArrayList<JToggleButton>();*/ protected JList semList; diff --git a/nuiton-matrix/src/main/java/cern/colt/GenericSorting.java b/nuiton-matrix/src/main/java/cern/colt/GenericSorting.java index fdc54dc..b05c03f 100644 --- a/nuiton-matrix/src/main/java/cern/colt/GenericSorting.java +++ b/nuiton-matrix/src/main/java/cern/colt/GenericSorting.java @@ -116,8 +116,8 @@ import cern.colt.function.IntComparator; * </td> * </tr> * </table> - * <h4>Sorting by multiple sorting criterias (primary, secondary, tertiary, ...) - * </h4> + * <b>Sorting by multiple sorting criterias (primary, secondary, tertiary, ...) + * </b> * <p> * Assume again we have three arrays X, Y and Z. Now we want to sort all three * arrays, primarily by Y, secondarily by Z (if Y elements are equal). For @@ -131,9 +131,10 @@ import cern.colt.function.IntComparator; * Here is how to solve the problem. All code in the above example stays the * same, except that we modify the comparison function as follows * </p> - * <table> + * <table summary=""> + * <tr> * <td class="PRE"> - * + * * <pre> * // compare by Y, if that doesn't help, reside to Z * IntComparator comp = new IntComparator() { @@ -146,9 +147,10 @@ import cern.colt.function.IntComparator; * </pre> * * </td> + * </tr> * </table> * - * <h4>Notes</h4> + * <b>Notes</b> * <p> * </p> * <p> @@ -163,7 +165,7 @@ import cern.colt.function.IntComparator; * <tt>(-0.0 == 0.0) == true</tt>, as well as * <tt>5.0 < Double.NaN == false</tt>, <tt>5.0 > Double.NaN == false</tt>. * Same for <tt>float</tt>. - * <h4>Implementation</h4> + * <b>Implementation</b> * <p> * The quicksort is a derivative of the JDK 1.2 V1.26 algorithms (which are, in * turn, based on Bentley's and McIlroy's fine work). The mergesort is a diff --git a/nuiton-matrix/src/main/java/cern/colt/list/AbstractDoubleList.java b/nuiton-matrix/src/main/java/cern/colt/list/AbstractDoubleList.java index b63c353..267f184 100644 --- a/nuiton-matrix/src/main/java/cern/colt/list/AbstractDoubleList.java +++ b/nuiton-matrix/src/main/java/cern/colt/list/AbstractDoubleList.java @@ -135,7 +135,7 @@ public abstract class AbstractDoubleList extends AbstractList implements * Inserts <tt>length</tt> dummy elements before the specified position into * the receiver. Shifts the element currently at that position (if any) and * any subsequent elements to the right. <b>This method must set the new - * size to be <tt>size()+length</tt>. + * size to be <tt>size()+length</tt></b>. * * @param index * index before which to insert dummy elements (must be in diff --git a/nuiton-matrix/src/main/java/cern/colt/list/AbstractLongList.java b/nuiton-matrix/src/main/java/cern/colt/list/AbstractLongList.java index 9bb89f6..d316881 100644 --- a/nuiton-matrix/src/main/java/cern/colt/list/AbstractLongList.java +++ b/nuiton-matrix/src/main/java/cern/colt/list/AbstractLongList.java @@ -63,7 +63,7 @@ public abstract class AbstractLongList extends AbstractList { * the index of the last element to be appended (inclusive). * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>other.size()>0 && (from<0 || from>to || to>=other.size())</tt> + * <tt>other.size()>0 && (from<0 || from>to || to>=other.size())</tt> * ). */ public void addAllOfFromTo(AbstractLongList other, int from, int to) { @@ -105,7 +105,7 @@ public abstract class AbstractLongList extends AbstractList { * the index of the last element to be inserted (inclusive). * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>other.size()>0 && (from<0 || from>to || to>=other.size())</tt> + * <tt>other.size()>0 && (from<0 || from>to || to>=other.size())</tt> * ). * @throws IndexOutOfBoundsException * if <tt>index < 0 || index > size()</tt>. @@ -121,7 +121,7 @@ public abstract class AbstractLongList extends AbstractList { * Inserts <tt>length</tt> dummy elements before the specified position into * the receiver. Shifts the element currently at that position (if any) and * any subsequent elements to the right. <b>This method must set the new - * size to be <tt>size()+length</tt>. + * size to be <tt>size()+length</tt></b>. * * @param index * index before which to insert dummy elements (must be in @@ -374,7 +374,7 @@ public abstract class AbstractLongList extends AbstractList { * parameters this method may return invalid elements without throwing any * exception! <b>You should only use this method when you are absolutely * sure that the index is within bounds.</b> Precondition (unchecked): - * <tt>index >= 0 && index < size()</tt>. + * <tt>index >= 0 && index < size()</tt>. * * This method is normally only used internally in large loops where bounds * are explicitly checked before the loop and need no be rechecked within @@ -415,7 +415,7 @@ public abstract class AbstractLongList extends AbstractList { * returns <code>-1</code> if the element is not found. * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> + * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> * ). */ public int indexOfFromTo(long element, int from, int to) { @@ -457,7 +457,7 @@ public abstract class AbstractLongList extends AbstractList { * returns <code>-1</code> if the element is not found. * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> + * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> * ). */ public int lastIndexOfFromTo(long element, int from, int to) { @@ -491,7 +491,7 @@ public abstract class AbstractLongList extends AbstractList { * the index of the last element (inclusive) to be sorted. * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> + * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> * ). */ public void mergeSortFromTo(int from, int to) { @@ -538,7 +538,7 @@ public abstract class AbstractLongList extends AbstractList { * @see Comparator * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> + * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> * ). */ public void mergeSortFromTo(int from, int to, LongComparator c) { @@ -562,7 +562,7 @@ public abstract class AbstractLongList extends AbstractList { * @return a new list * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> + * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> * ). */ public AbstractLongList partFromTo(int from, int to) { @@ -595,7 +595,7 @@ public abstract class AbstractLongList extends AbstractList { * the index of the last element (inclusive) to be sorted. * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> + * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> * ). */ public void quickSortFromTo(int from, int to) { @@ -639,7 +639,7 @@ public abstract class AbstractLongList extends AbstractList { * @see Comparator * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> + * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> * ). */ public void quickSortFromTo(int from, int to, LongComparator c) { @@ -689,7 +689,7 @@ public abstract class AbstractLongList extends AbstractList { * index of last element to be removed. * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> + * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> * ). */ public void removeFromTo(int from, int to) { @@ -925,7 +925,7 @@ public abstract class AbstractLongList extends AbstractList { * with invalid parameters this method may access invalid indexes without * throwing any exception! <b>You should only use this method when you are * absolutely sure that the index is within bounds.</b> Precondition - * (unchecked): <tt>index >= 0 && index < size()</tt>. + * (unchecked): <tt>index >= 0 && index < size()</tt>. * * This method is normally only used internally in large loops where bounds * are explicitly checked before the loop and need no be rechecked within @@ -965,7 +965,7 @@ public abstract class AbstractLongList extends AbstractList { * the index of the last element (inclusive) to be permuted. * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> + * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> * ). */ public void shuffleFromTo(int from, int to) { @@ -986,7 +986,7 @@ public abstract class AbstractLongList extends AbstractList { /** * Returns the number of elements contained in the receiver. * - * @returns the number of elements contained in the receiver. + * @return the number of elements contained in the receiver. */ public int size() { return size; diff --git a/nuiton-matrix/src/main/java/cern/colt/list/ByteArrayList.java b/nuiton-matrix/src/main/java/cern/colt/list/ByteArrayList.java index c8a6488..2fbca4d 100644 --- a/nuiton-matrix/src/main/java/cern/colt/list/ByteArrayList.java +++ b/nuiton-matrix/src/main/java/cern/colt/list/ByteArrayList.java @@ -4,7 +4,7 @@ Permission to use, copy, modify, distribute and sell this software and its docum is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation. CERN makes no representations about the suitability of this software for any purpose. -It is provided "as is" without expressed or implied warranty. +It is provided "as is" without expressed or implied warranty. %%Ignore-License */ package cern.colt.list; @@ -199,8 +199,11 @@ public class ByteArrayList extends AbstractByteList { * Sorts the specified range of the receiver into ascending numerical order. * * The sorting algorithm is a count sort. This algorithm offers guaranteed - * <dt>Performance: O(Max(n,max-min+1)). <dt>Space requirements: - * int[max-min+1] buffer. + * <dl> + * <dt>Performance: O(Max(n,max-min+1)).</dt> + * <dt>Space requirements: + * int[max-min+1] buffer.</dt> + * </dl> * <p> * This algorithm is only applicable if max-min+1 is not large! But if * applicable, it usually outperforms quicksort by a factor of 3-4. @@ -365,7 +368,7 @@ public class ByteArrayList extends AbstractByteList { * parameters this method may return invalid elements without throwing any * exception! <b>You should only use this method when you are absolutely * sure that the index is within bounds.</b> Precondition (unchecked): - * <tt>index >= 0 && index < size()</tt>. + * <tt>index >= 0 && index < size()</tt>. * * @param index * index of element to return. @@ -390,7 +393,7 @@ public class ByteArrayList extends AbstractByteList { * returns <code>-1</code> if the element is not found. * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> + * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> * ). */ public int indexOfFromTo(byte element, int from, int to) { @@ -424,7 +427,7 @@ public class ByteArrayList extends AbstractByteList { * returns <code>-1</code> if the element is not found. * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> + * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> * ). */ public int lastIndexOfFromTo(byte element, int from, int to) { @@ -453,7 +456,7 @@ public class ByteArrayList extends AbstractByteList { * @return a new list * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> + * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> * ). */ public AbstractByteList partFromTo(int from, int to) { @@ -656,7 +659,7 @@ public class ByteArrayList extends AbstractByteList { * with invalid parameters this method may access invalid indexes without * throwing any exception! <b>You should only use this method when you are * absolutely sure that the index is within bounds.</b> Precondition - * (unchecked): <tt>index >= 0 && index < size()</tt>. + * (unchecked): <tt>index >= 0 && index < size()</tt>. * * @param index * index of element to replace. @@ -677,7 +680,7 @@ public class ByteArrayList extends AbstractByteList { * the index of the last element (inclusive) to be permuted. * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> + * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> * ). */ public void shuffleFromTo(int from, int to) { @@ -713,7 +716,7 @@ public class ByteArrayList extends AbstractByteList { * the index of the last element (inclusive) to be sorted. * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> + * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> * ). */ public void sortFromTo(int from, int to) { diff --git a/nuiton-matrix/src/main/java/cern/colt/list/DoubleArrayList.java b/nuiton-matrix/src/main/java/cern/colt/list/DoubleArrayList.java index 2244cd3..39cdea3 100644 --- a/nuiton-matrix/src/main/java/cern/colt/list/DoubleArrayList.java +++ b/nuiton-matrix/src/main/java/cern/colt/list/DoubleArrayList.java @@ -4,7 +4,7 @@ Permission to use, copy, modify, distribute and sell this software and its docum is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation. CERN makes no representations about the suitability of this software for any purpose. -It is provided "as is" without expressed or implied warranty. +It is provided "as is" without expressed or implied warranty. %%Ignore-License */ package cern.colt.list; @@ -281,7 +281,7 @@ public class DoubleArrayList extends AbstractDoubleList { * parameters this method may return invalid elements without throwing any * exception! <b>You should only use this method when you are absolutely * sure that the index is within bounds.</b> Precondition (unchecked): - * <tt>index >= 0 && index < size()</tt>. + * <tt>index >= 0 && index < size()</tt>. * * @param index * index of element to return. @@ -306,7 +306,7 @@ public class DoubleArrayList extends AbstractDoubleList { * returns <code>-1</code> if the element is not found. * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> + * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> * ). */ public int indexOfFromTo(double element, int from, int to) { @@ -340,7 +340,7 @@ public class DoubleArrayList extends AbstractDoubleList { * returns <code>-1</code> if the element is not found. * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> + * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> * ). */ public int lastIndexOfFromTo(double element, int from, int to) { @@ -369,7 +369,7 @@ public class DoubleArrayList extends AbstractDoubleList { * @return a new list * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> + * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> * ). */ public AbstractDoubleList partFromTo(int from, int to) { @@ -572,7 +572,7 @@ public class DoubleArrayList extends AbstractDoubleList { * with invalid parameters this method may access invalid indexes without * throwing any exception! <b>You should only use this method when you are * absolutely sure that the index is within bounds.</b> Precondition - * (unchecked): <tt>index >= 0 && index < size()</tt>. + * (unchecked): <tt>index >= 0 && index < size()</tt>. * * @param index * index of element to replace. @@ -593,7 +593,7 @@ public class DoubleArrayList extends AbstractDoubleList { * the index of the last element (inclusive) to be permuted. * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> + * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> * ). */ public void shuffleFromTo(int from, int to) { diff --git a/nuiton-matrix/src/main/java/cern/colt/list/FloatArrayList.java b/nuiton-matrix/src/main/java/cern/colt/list/FloatArrayList.java index 17931d2..a03ebc6 100644 --- a/nuiton-matrix/src/main/java/cern/colt/list/FloatArrayList.java +++ b/nuiton-matrix/src/main/java/cern/colt/list/FloatArrayList.java @@ -4,7 +4,7 @@ Permission to use, copy, modify, distribute and sell this software and its docum is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation. CERN makes no representations about the suitability of this software for any purpose. -It is provided "as is" without expressed or implied warranty. +It is provided "as is" without expressed or implied warranty. %%Ignore-License */ package cern.colt.list; @@ -277,7 +277,7 @@ public class FloatArrayList extends AbstractFloatList { * parameters this method may return invalid elements without throwing any * exception! <b>You should only use this method when you are absolutely * sure that the index is within bounds.</b> Precondition (unchecked): - * <tt>index >= 0 && index < size()</tt>. + * <tt>index >= 0 && index < size()</tt>. * * @param index * index of element to return. @@ -302,7 +302,7 @@ public class FloatArrayList extends AbstractFloatList { * returns <code>-1</code> if the element is not found. * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> + * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> * ). */ public int indexOfFromTo(float element, int from, int to) { @@ -336,7 +336,7 @@ public class FloatArrayList extends AbstractFloatList { * returns <code>-1</code> if the element is not found. * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> + * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> * ). */ public int lastIndexOfFromTo(float element, int from, int to) { @@ -365,7 +365,7 @@ public class FloatArrayList extends AbstractFloatList { * @return a new list * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> + * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> * ). */ public AbstractFloatList partFromTo(int from, int to) { @@ -568,7 +568,7 @@ public class FloatArrayList extends AbstractFloatList { * with invalid parameters this method may access invalid indexes without * throwing any exception! <b>You should only use this method when you are * absolutely sure that the index is within bounds.</b> Precondition - * (unchecked): <tt>index >= 0 && index < size()</tt>. + * (unchecked): <tt>index >= 0 && index < size()</tt>. * * @param index * index of element to replace. @@ -589,7 +589,7 @@ public class FloatArrayList extends AbstractFloatList { * the index of the last element (inclusive) to be permuted. * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> + * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> * ). */ public void shuffleFromTo(int from, int to) { diff --git a/nuiton-matrix/src/main/java/cern/colt/list/IntArrayList.java b/nuiton-matrix/src/main/java/cern/colt/list/IntArrayList.java index bbb8142..c07df4f 100644 --- a/nuiton-matrix/src/main/java/cern/colt/list/IntArrayList.java +++ b/nuiton-matrix/src/main/java/cern/colt/list/IntArrayList.java @@ -4,7 +4,7 @@ Permission to use, copy, modify, distribute and sell this software and its docum is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation. CERN makes no representations about the suitability of this software for any purpose. -It is provided "as is" without expressed or implied warranty. +It is provided "as is" without expressed or implied warranty. %%Ignore-License */ package cern.colt.list; @@ -163,8 +163,11 @@ public class IntArrayList extends AbstractIntList { * Sorts the specified range of the receiver into ascending numerical order. * * The sorting algorithm is a count sort. This algorithm offers guaranteed - * <dt>Performance: O(Max(n,max-min+1)). <dt>Space requirements: - * int[max-min+1] buffer. + * <dl> + * <dt>Performance: O(Max(n,max-min+1)).</dt> + * <dt>Space requirements: + * int[max-min+1] buffer.</dt> + * </dl> * <p> * This algorithm is only applicable if max-min+1 is not large! But if * applicable, it usually outperforms quicksort by a factor of 3-4. @@ -329,7 +332,7 @@ public class IntArrayList extends AbstractIntList { * parameters this method may return invalid elements without throwing any * exception! <b>You should only use this method when you are absolutely * sure that the index is within bounds.</b> Precondition (unchecked): - * <tt>index >= 0 && index < size()</tt>. + * <tt>index >= 0 && index < size()</tt>. * * @param index * index of element to return. @@ -354,7 +357,7 @@ public class IntArrayList extends AbstractIntList { * returns <code>-1</code> if the element is not found. * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> + * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> * ). */ public int indexOfFromTo(int element, int from, int to) { @@ -388,7 +391,7 @@ public class IntArrayList extends AbstractIntList { * returns <code>-1</code> if the element is not found. * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> + * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> * ). */ public int lastIndexOfFromTo(int element, int from, int to) { @@ -417,7 +420,7 @@ public class IntArrayList extends AbstractIntList { * @return a new list * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> + * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> * ). */ public AbstractIntList partFromTo(int from, int to) { @@ -620,7 +623,7 @@ public class IntArrayList extends AbstractIntList { * with invalid parameters this method may access invalid indexes without * throwing any exception! <b>You should only use this method when you are * absolutely sure that the index is within bounds.</b> Precondition - * (unchecked): <tt>index >= 0 && index < size()</tt>. + * (unchecked): <tt>index >= 0 && index < size()</tt>. * * @param index * index of element to replace. @@ -641,7 +644,7 @@ public class IntArrayList extends AbstractIntList { * the index of the last element (inclusive) to be permuted. * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> + * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> * ). */ public void shuffleFromTo(int from, int to) { @@ -676,16 +679,17 @@ public class IntArrayList extends AbstractIntList { * * <p> * Best case performance: O(N). - * <dt>Worst case performance: O(N^2) (a degenerated quicksort). - * <dt>Best case space requirements: 0 KB. - * <dt>Worst case space requirements: 40 KB. - * + * <dl> + * <dt>Worst case performance: O(N^2) (a degenerated quicksort).</dt> + * <dt>Best case space requirements: 0 KB.</dt> + * <dt>Worst case space requirements: 40 KB.</dt> + * </dl> * @param from * the index of the first element (inclusive) to be sorted. * @param to * the index of the last element (inclusive) to be sorted. * @exception IndexOutOfBoundsException - * index is out of range (<tt>size()>0 && (from<0 || + * index is out of range (<tt>size()>0 && (from<0 || * from>to || to>=size())</tt>). */ public void sortFromTo(int from, int to) { diff --git a/nuiton-matrix/src/main/java/cern/colt/list/LongArrayList.java b/nuiton-matrix/src/main/java/cern/colt/list/LongArrayList.java index 9968203..973d446 100644 --- a/nuiton-matrix/src/main/java/cern/colt/list/LongArrayList.java +++ b/nuiton-matrix/src/main/java/cern/colt/list/LongArrayList.java @@ -4,7 +4,7 @@ Permission to use, copy, modify, distribute and sell this software and its docum is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation. CERN makes no representations about the suitability of this software for any purpose. -It is provided "as is" without expressed or implied warranty. +It is provided "as is" without expressed or implied warranty. %%Ignore-License */ package cern.colt.list; @@ -158,8 +158,11 @@ public class LongArrayList extends AbstractLongList { * Sorts the specified range of the receiver into ascending numerical order. * * The sorting algorithm is a count sort. This algorithm offers guaranteed - * <dt>Performance: O(Max(n,max-min+1)). <dt>Space requirements: - * int[max-min+1] buffer. + * <dl> + * <dt>Performance: O(Max(n,max-min+1)).</dt> + * <dt>Space requirements: + * int[max-min+1] buffer.</dt> + * </dl> * <p> * This algorithm is only applicable if max-min+1 is not large! But if * applicable, it usually outperforms quicksort by a factor of 3-4. @@ -324,7 +327,7 @@ public class LongArrayList extends AbstractLongList { * parameters this method may return invalid elements without throwing any * exception! <b>You should only use this method when you are absolutely * sure that the index is within bounds.</b> Precondition (unchecked): - * <tt>index >= 0 && index < size()</tt>. + * <tt>index >= 0 && index < size()</tt>. * * @param index * index of element to return. @@ -349,7 +352,7 @@ public class LongArrayList extends AbstractLongList { * returns <code>-1</code> if the element is not found. * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> + * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> * ). */ public int indexOfFromTo(long element, int from, int to) { @@ -383,7 +386,7 @@ public class LongArrayList extends AbstractLongList { * returns <code>-1</code> if the element is not found. * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> + * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> * ). */ public int lastIndexOfFromTo(long element, int from, int to) { @@ -412,7 +415,7 @@ public class LongArrayList extends AbstractLongList { * @return a new list * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> + * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> * ). */ public AbstractLongList partFromTo(int from, int to) { @@ -615,7 +618,7 @@ public class LongArrayList extends AbstractLongList { * with invalid parameters this method may access invalid indexes without * throwing any exception! <b>You should only use this method when you are * absolutely sure that the index is within bounds.</b> Precondition - * (unchecked): <tt>index >= 0 && index < size()</tt>. + * (unchecked): <tt>index >= 0 && index < size()</tt>. * * @param index * index of element to replace. @@ -636,7 +639,7 @@ public class LongArrayList extends AbstractLongList { * the index of the last element (inclusive) to be permuted. * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> + * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> * ). */ public void shuffleFromTo(int from, int to) { @@ -670,16 +673,18 @@ public class LongArrayList extends AbstractLongList { * * <p> * Best case performance: O(N). - * <dt>Worst case performance: O(N^2) (a degenerated quicksort). - * <dt>Best case space requirements: 0 KB. - * <dt>Worst case space requirements: 40 KB. - * + * <dl> + * <dt>Worst case performance: O(N^2) (a degenerated quicksort).</dt> + * <dt>Best case space requirements: 0 KB.</dt> + * <dt>Worst case space requirements: 40 KB.</dt> + * </dl> + * * @param from * the index of the first element (inclusive) to be sorted. * @param to * the index of the last element (inclusive) to be sorted. * @exception IndexOutOfBoundsException - * index is out of range (<tt>size()>0 && (from<0 || + * index is out of range (<tt>size()>0 && (from<0 || * from>to || to>=size())</tt>). */ public void sortFromTo(int from, int to) { diff --git a/nuiton-matrix/src/main/java/cern/colt/list/ObjectArrayList.java b/nuiton-matrix/src/main/java/cern/colt/list/ObjectArrayList.java index d67939f..5d9c803 100644 --- a/nuiton-matrix/src/main/java/cern/colt/list/ObjectArrayList.java +++ b/nuiton-matrix/src/main/java/cern/colt/list/ObjectArrayList.java @@ -98,7 +98,7 @@ public class ObjectArrayList<T> extends AbstractList { * the index of the last element to be appended (inclusive). * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>other.size()>0 && (from<0 || from>to || to>=other.size())</tt> + * <tt>other.size()>0 && (from<0 || from>to || to>=other.size())</tt> * ). */ public void addAllOfFromTo(ObjectArrayList other, int from, int to) { @@ -147,7 +147,7 @@ public class ObjectArrayList<T> extends AbstractList { * the index of the last element to be inserted (inclusive). * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>other.size()>0 && (from<0 || from>to || to>=other.size())</tt> + * <tt>other.size()>0 && (from<0 || from>to || to>=other.size())</tt> * ). * @exception IndexOutOfBoundsException * index is out of range ( @@ -540,7 +540,7 @@ public class ObjectArrayList<T> extends AbstractList { * parameters this method may return invalid elements without throwing any * exception! <b>You should only use this method when you are absolutely * sure that the index is within bounds.</b> Precondition (unchecked): - * <tt>index >= 0 && index < size()</tt>. + * <tt>index >= 0 && index < size()</tt>. * * @param index * index of element to return. @@ -581,13 +581,13 @@ public class ObjectArrayList<T> extends AbstractList { * @param to * the rightmost search position, inclusive. * @param testForEquality - * if </code>true</code> -> test for equality, otherwise for + * if <code>true</code> -> test for equality, otherwise for * identity. * @return the index of the first occurrence of the element in the receiver; * returns <code>-1</code> if the element is not found. * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> + * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> * ). */ public int indexOfFromTo(Object element, int from, int to, @@ -631,7 +631,7 @@ public class ObjectArrayList<T> extends AbstractList { * otherwise. * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> + * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> * ). */ public boolean isSortedFromTo(int from, int to) { @@ -686,7 +686,7 @@ public class ObjectArrayList<T> extends AbstractList { * returns <code>-1</code> if the element is not found. * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> + * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> * ). */ public int lastIndexOfFromTo(Object element, int from, int to, @@ -744,7 +744,7 @@ public class ObjectArrayList<T> extends AbstractList { * the index of the last element (inclusive) to be sorted. * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> + * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> * ). */ public void mergeSortFromTo(int from, int to) { @@ -787,7 +787,7 @@ public class ObjectArrayList<T> extends AbstractList { * <tt>toIndex > a.length</tt> * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> + * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> * ). * @see Comparator */ @@ -809,7 +809,7 @@ public class ObjectArrayList<T> extends AbstractList { * @return a new list * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> + * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> * ). */ public ObjectArrayList partFromTo(int from, int to) { @@ -851,7 +851,7 @@ public class ObjectArrayList<T> extends AbstractList { * the index of the last element (inclusive) to be sorted. * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> + * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> * ). */ public void quickSortFromTo(int from, int to) { @@ -892,7 +892,7 @@ public class ObjectArrayList<T> extends AbstractList { * @see Comparator * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> + * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> * ). */ public void quickSortFromTo(int from, int to, java.util.Comparator c) { @@ -943,7 +943,7 @@ public class ObjectArrayList<T> extends AbstractList { * index of last element to be removed. * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> + * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> * ). */ public void removeFromTo(int from, int to) { @@ -1180,7 +1180,7 @@ public class ObjectArrayList<T> extends AbstractList { * with invalid parameters this method may access invalid indexes without * throwing any exception! <b>You should only use this method when you are * absolutely sure that the index is within bounds.</b> Precondition - * (unchecked): <tt>index >= 0 && index < size()</tt>. + * (unchecked): <tt>index >= 0 && index < size()</tt>. * * @param index * index of element to replace. @@ -1201,7 +1201,7 @@ public class ObjectArrayList<T> extends AbstractList { * the index of the last element (inclusive) to be permuted. * @exception IndexOutOfBoundsException * index is out of range ( - * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> + * <tt>size()>0 && (from<0 || from>to || to>=size())</tt> * ). */ public void shuffleFromTo(int from, int to) { @@ -1227,7 +1227,7 @@ public class ObjectArrayList<T> extends AbstractList { /** * Returns the number of elements contained in the receiver. * - * @returns the number of elements contained in the receiver. + * @return the number of elements contained in the receiver. */ public int size() { return size; diff --git a/nuiton-matrix/src/main/java/cern/colt/map/AbstractDoubleIntMap.java b/nuiton-matrix/src/main/java/cern/colt/map/AbstractDoubleIntMap.java index 541d3dd..52564a2 100644 --- a/nuiton-matrix/src/main/java/cern/colt/map/AbstractDoubleIntMap.java +++ b/nuiton-matrix/src/main/java/cern/colt/map/AbstractDoubleIntMap.java @@ -94,7 +94,7 @@ public abstract class AbstractDoubleIntMap extends AbstractMap { * } * } * ) - * && + * && * m2.forEachPair( * new DoubleIntProcedure() { * public boolean apply(double key, int value) { @@ -282,7 +282,7 @@ public abstract class AbstractDoubleIntMap extends AbstractMap { * DoubleIntProcedure condition = new DoubleIntProcedure() { // match even values only * public boolean apply(double key, int value) { return value%2==0; } * } - * keys = (8,7,6), values = (1,2,2) --> keyList = (6,8), valueList = (2,1)</tt> + * keys = (8,7,6), values = (1,2,2) --> keyList = (6,8), valueList = (2,1) * </pre> * * @param condition diff --git a/nuiton-matrix/src/main/java/cern/colt/map/AbstractIntDoubleMap.java b/nuiton-matrix/src/main/java/cern/colt/map/AbstractIntDoubleMap.java index 058b2e9..aefa595 100644 --- a/nuiton-matrix/src/main/java/cern/colt/map/AbstractIntDoubleMap.java +++ b/nuiton-matrix/src/main/java/cern/colt/map/AbstractIntDoubleMap.java @@ -128,7 +128,7 @@ public abstract class AbstractIntDoubleMap extends AbstractMap { * } * } * ) - * && + * && * m2.forEachPair( * new IntDoubleProcedure() { * public boolean apply(int key, double value) { @@ -315,7 +315,7 @@ public abstract class AbstractIntDoubleMap extends AbstractMap { * IntDoubleProcedure condition = new IntDoubleProcedure() { // match even keys only * public boolean apply(int key, double value) { return key%2==0; } * } - * keys = (8,7,6), values = (1,2,2) --> keyList = (6,8), valueList = (2,1)</tt> + * keys = (8,7,6), values = (1,2,2) --> keyList = (6,8), valueList = (2,1) * </pre> * * @param condition diff --git a/nuiton-matrix/src/main/java/cern/colt/map/AbstractIntIntMap.java b/nuiton-matrix/src/main/java/cern/colt/map/AbstractIntIntMap.java index 7610d3e..65d3b92 100644 --- a/nuiton-matrix/src/main/java/cern/colt/map/AbstractIntIntMap.java +++ b/nuiton-matrix/src/main/java/cern/colt/map/AbstractIntIntMap.java @@ -93,7 +93,7 @@ public abstract class AbstractIntIntMap extends AbstractMap { * } * } * ) - * && + * && * m2.forEachPair( * new IntIntProcedure() { * public boolean apply(int key, int value) { @@ -280,7 +280,7 @@ public abstract class AbstractIntIntMap extends AbstractMap { * IntIntProcedure condition = new IntIntProcedure() { // match even keys only * public boolean apply(int key, int value) { return key%2==0; } * } - * keys = (8,7,6), values = (1,2,2) --> keyList = (6,8), valueList = (2,1)</tt> + * keys = (8,7,6), values = (1,2,2) --> keyList = (6,8), valueList = (2,1) * </pre> * * @param condition diff --git a/nuiton-matrix/src/main/java/cern/colt/map/AbstractIntObjectMap.java b/nuiton-matrix/src/main/java/cern/colt/map/AbstractIntObjectMap.java index 86b962e..724f0a3 100644 --- a/nuiton-matrix/src/main/java/cern/colt/map/AbstractIntObjectMap.java +++ b/nuiton-matrix/src/main/java/cern/colt/map/AbstractIntObjectMap.java @@ -16,7 +16,7 @@ import cern.colt.list.ObjectArrayList; /** * Abstract base class for hash maps holding (key,value) associations of type - * <tt>(int-->Object)</tt>. First see the <a href="package-summary.html">package + * <tt>(int-->Object)</tt>. First see the <a href="package-summary.html">package * summary</a> and javadoc <a href="package-tree.html">tree view</a> to get the * broad picture. * <p> @@ -95,7 +95,7 @@ public abstract class AbstractIntObjectMap<T> extends AbstractMap { * } * } * ) - * && + * && * m2.forEachPair( * new IntObjectProcedure() { * public boolean apply(int key, Object value) { @@ -282,7 +282,7 @@ public abstract class AbstractIntObjectMap<T> extends AbstractMap { * IntObjectProcedure condition = new IntObjectProcedure() { // match even keys only * public boolean apply(int key, Object value) { return key%2==0; } * } - * keys = (8,7,6), values = (1,2,2) --> keyList = (6,8), valueList = (2,1)</tt> + * keys = (8,7,6), values = (1,2,2) --> keyList = (6,8), valueList = (2,1) * </pre> * * @param condition diff --git a/nuiton-matrix/src/main/java/cern/colt/map/AbstractLongObjectMap.java b/nuiton-matrix/src/main/java/cern/colt/map/AbstractLongObjectMap.java index 775901c..11a90e9 100644 --- a/nuiton-matrix/src/main/java/cern/colt/map/AbstractLongObjectMap.java +++ b/nuiton-matrix/src/main/java/cern/colt/map/AbstractLongObjectMap.java @@ -16,7 +16,7 @@ import cern.colt.list.ObjectArrayList; /** * Abstract base class for hash maps holding (key,value) associations of type - * <tt>(long-->Object)</tt>. First see the <a + * <tt>(long-->Object)</tt>. First see the <a * href="package-summary.html">package summary</a> and javadoc <a * href="package-tree.html">tree view</a> to get the broad picture. * <p> @@ -91,15 +91,15 @@ public abstract class AbstractLongObjectMap<T> extends AbstractMap { * m1.forEachPair( * new LongObjectProcedure() { * public boolean apply(long key, Object value) { - * return m2.containsKey(key) && m2.get(key) == value; + * return m2.containsKey(key) && m2.get(key) == value; * } * } * ) - * && + * && * m2.forEachPair( * new LongObjectProcedure() { * public boolean apply(long key, Object value) { - * return m1.containsKey(key) && m1.get(key) == value; + * return m1.containsKey(key) && m1.get(key) == value; * } * } * ); @@ -282,7 +282,7 @@ public abstract class AbstractLongObjectMap<T> extends AbstractMap { * LongObjectProcedure condition = new LongObjectProcedure() { // match even keys only * public boolean apply(long key, Object value) { return key%2==0; } * } - * keys = (8,7,6), values = (1,2,2) --> keyList = (6,8), valueList = (2,1)</tt> + * keys = (8,7,6), values = (1,2,2) --> keyList = (6,8), valueList = (2,1) * </pre> * * @param condition diff --git a/nuiton-matrix/src/main/java/cern/colt/map/AbstractMap.java b/nuiton-matrix/src/main/java/cern/colt/map/AbstractMap.java index 6f47bae..b927652 100644 --- a/nuiton-matrix/src/main/java/cern/colt/map/AbstractMap.java +++ b/nuiton-matrix/src/main/java/cern/colt/map/AbstractMap.java @@ -4,7 +4,7 @@ Permission to use, copy, modify, distribute and sell this software and its docum is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation. CERN makes no representations about the suitability of this software for any purpose. -It is provided "as is" without expressed or implied warranty. +It is provided "as is" without expressed or implied warranty. %%Ignore-License */ package cern.colt.map; @@ -36,7 +36,7 @@ public abstract class AbstractMap extends cern.colt.PersistentObject { /** * The table capacity c=table.length always satisfies the invariant - * <tt>c * minLoadFactor <= s <= c * maxLoadFactor</tt>, where s=size() is + * <tt>c * minLoadFactor <= s <= c * maxLoadFactor</tt>, where s=size() is * the number of associations currently contained. The term * "c * minLoadFactor" is called the "lowWaterMark", "c * maxLoadFactor" is * called the "highWaterMark". In other words, the table capacity (and @@ -71,7 +71,7 @@ public abstract class AbstractMap extends cern.colt.PersistentObject { /** * Chooses a new prime table capacity optimized for growing that * (approximately) satisfies the invariant - * <tt>c * minLoadFactor <= size <= c * maxLoadFactor</tt> and has at least + * <tt>c * minLoadFactor <= size <= c * maxLoadFactor</tt> and has at least * one FREE slot for the given size. */ protected int chooseGrowCapacity(int size, double minLoad, double maxLoad) { @@ -106,7 +106,7 @@ public abstract class AbstractMap extends cern.colt.PersistentObject { /** * Chooses a new prime table capacity neither favoring shrinking nor * growing, that (approximately) satisfies the invariant - * <tt>c * minLoadFactor <= size <= c * maxLoadFactor</tt> and has at least + * <tt>c * minLoadFactor <= size <= c * maxLoadFactor</tt> and has at least * one FREE slot for the given size. */ protected int chooseMeanCapacity(int size, double minLoad, double maxLoad) { @@ -117,7 +117,7 @@ public abstract class AbstractMap extends cern.colt.PersistentObject { /** * Chooses a new prime table capacity optimized for shrinking that * (approximately) satisfies the invariant - * <tt>c * minLoadFactor <= size <= c * maxLoadFactor</tt> and has at least + * <tt>c * minLoadFactor <= size <= c * maxLoadFactor</tt> and has at least * one FREE slot for the given size. */ protected int chooseShrinkCapacity(int size, double minLoad, double maxLoad) { @@ -185,7 +185,7 @@ public abstract class AbstractMap extends cern.colt.PersistentObject { * the maxLoadFactor of the receiver. * @throws IllegalArgumentException * if - * <tt>initialCapacity < 0 || (minLoadFactor < 0.0 || minLoadFactor >= 1.0) || (maxLoadFactor <= 0.0 || maxLoadFactor >= 1.0) || (minLoadFactor >= maxLoadFactor)</tt> + * <tt>initialCapacity < 0 || (minLoadFactor < 0.0 || minLoadFactor >= 1.0) || (maxLoadFactor <= 0.0 || maxLoadFactor >= 1.0) || (minLoadFactor >= maxLoadFactor)</tt> * . */ protected void setUp(int initialCapacity, double minLoadFactor, diff --git a/nuiton-matrix/src/main/java/cern/colt/map/OpenDoubleIntHashMap.java b/nuiton-matrix/src/main/java/cern/colt/map/OpenDoubleIntHashMap.java index 3446409..37f403c 100644 --- a/nuiton-matrix/src/main/java/cern/colt/map/OpenDoubleIntHashMap.java +++ b/nuiton-matrix/src/main/java/cern/colt/map/OpenDoubleIntHashMap.java @@ -16,7 +16,7 @@ import cern.colt.list.DoubleArrayList; import cern.colt.list.IntArrayList; /** - * Hash map holding (key,value) associations of type <tt>(double-->int)</tt>; + * Hash map holding (key,value) associations of type <tt>(double-->int)</tt>; * Automatically grows and shrinks as needed; Implemented using open addressing * with double hashing. First see the <a href="package-summary.html">package * summary</a> and javadoc <a href="package-tree.html">tree view</a> to get the @@ -98,7 +98,7 @@ public class OpenDoubleIntHashMap extends AbstractDoubleIntMap { * the maximum load factor. * @throws IllegalArgumentException * if - * <tt>initialCapacity < 0 || (minLoadFactor < 0.0 || minLoadFactor >= 1.0) || (maxLoadFactor <= 0.0 || maxLoadFactor >= 1.0) || (minLoadFactor >= maxLoadFactor)</tt> + * <tt>initialCapacity < 0 || (minLoadFactor < 0.0 || minLoadFactor >= 1.0) || (maxLoadFactor <= 0.0 || maxLoadFactor >= 1.0) || (minLoadFactor >= maxLoadFactor)</tt> * . */ public OpenDoubleIntHashMap(int initialCapacity, double minLoadFactor, @@ -241,9 +241,9 @@ public class OpenDoubleIntHashMap extends AbstractDoubleIntMap { * the key to be added to the receiver. * @return the index where the key would need to be inserted, if it is not * already contained. Returns -index-1 if the key is already - * contained at slot index. Therefore, if the returned index < 0, + * contained at slot index. Therefore, if the returned index < 0, * then it is already contained at slot -index-1. If the returned - * index >= 0, then it is NOT already contained and should be + * index >= 0, then it is NOT already contained and should be * inserted at slot index. */ protected int indexOfInsertion(double key) { @@ -404,7 +404,7 @@ public class OpenDoubleIntHashMap extends AbstractDoubleIntMap { * DoubleIntProcedure condition = new DoubleIntProcedure() { // match even values only * public boolean apply(double key, int value) { return value%2==0; } * } - * keys = (8,7,6), values = (1,2,2) --> keyList = (6,8), valueList = (2,1)</tt> + * keys = (8,7,6), values = (1,2,2) --> keyList = (6,8), valueList = (2,1) * </pre> * * @param condition @@ -560,7 +560,7 @@ public class OpenDoubleIntHashMap extends AbstractDoubleIntMap { * the maxLoadFactor of the receiver. * @throws IllegalArgumentException * if - * <tt>initialCapacity < 0 || (minLoadFactor < 0.0 || minLoadFactor >= 1.0) || (maxLoadFactor <= 0.0 || maxLoadFactor >= 1.0) || (minLoadFactor >= maxLoadFactor)</tt> + * <tt>initialCapacity < 0 || (minLoadFactor < 0.0 || minLoadFactor >= 1.0) || (maxLoadFactor <= 0.0 || maxLoadFactor >= 1.0) || (minLoadFactor >= maxLoadFactor)</tt> * . */ protected void setUp(int initialCapacity, double minLoadFactor, diff --git a/nuiton-matrix/src/main/java/cern/colt/map/OpenIntDoubleHashMap.java b/nuiton-matrix/src/main/java/cern/colt/map/OpenIntDoubleHashMap.java index 973925e..1eac743 100644 --- a/nuiton-matrix/src/main/java/cern/colt/map/OpenIntDoubleHashMap.java +++ b/nuiton-matrix/src/main/java/cern/colt/map/OpenIntDoubleHashMap.java @@ -16,7 +16,7 @@ import cern.colt.list.DoubleArrayList; import cern.colt.list.IntArrayList; /** - * Hash map holding (key,value) associations of type <tt>(int-->double)</tt>; + * Hash map holding (key,value) associations of type <tt>(int-->double)</tt>; * Automatically grows and shrinks as needed; Implemented using open addressing * with double hashing. First see the <a href="package-summary.html">package * summary</a> and javadoc <a href="package-tree.html">tree view</a> to get the @@ -99,7 +99,7 @@ public class OpenIntDoubleHashMap extends AbstractIntDoubleMap { * the maximum load factor. * @throws IllegalArgumentException * if - * <tt>initialCapacity < 0 || (minLoadFactor < 0.0 || minLoadFactor >= 1.0) || (maxLoadFactor <= 0.0 || maxLoadFactor >= 1.0) || (minLoadFactor >= maxLoadFactor)</tt> + * <tt>initialCapacity < 0 || (minLoadFactor < 0.0 || minLoadFactor >= 1.0) || (maxLoadFactor <= 0.0 || maxLoadFactor >= 1.0) || (minLoadFactor >= maxLoadFactor)</tt> * . */ public OpenIntDoubleHashMap(int initialCapacity, double minLoadFactor, @@ -302,9 +302,9 @@ public class OpenIntDoubleHashMap extends AbstractIntDoubleMap { * the key to be added to the receiver. * @return the index where the key would need to be inserted, if it is not * already contained. Returns -index-1 if the key is already - * contained at slot index. Therefore, if the returned index < 0, + * contained at slot index. Therefore, if the returned index < 0, * then it is already contained at slot -index-1. If the returned - * index >= 0, then it is NOT already contained and should be + * index >= 0, then it is NOT already contained and should be * inserted at slot index. */ protected int indexOfInsertion(int key) { @@ -466,7 +466,7 @@ public class OpenIntDoubleHashMap extends AbstractIntDoubleMap { * IntDoubleProcedure condition = new IntDoubleProcedure() { // match even keys only * public boolean apply(int key, double value) { return key%2==0; } * } - * keys = (8,7,6), values = (1,2,2) --> keyList = (6,8), valueList = (2,1)</tt> + * keys = (8,7,6), values = (1,2,2) --> keyList = (6,8), valueList = (2,1) * </pre> * * @param condition @@ -636,7 +636,7 @@ public class OpenIntDoubleHashMap extends AbstractIntDoubleMap { * the maxLoadFactor of the receiver. * @throws IllegalArgumentException * if - * <tt>initialCapacity < 0 || (minLoadFactor < 0.0 || minLoadFactor >= 1.0) || (maxLoadFactor <= 0.0 || maxLoadFactor >= 1.0) || (minLoadFactor >= maxLoadFactor)</tt> + * <tt>initialCapacity < 0 || (minLoadFactor < 0.0 || minLoadFactor >= 1.0) || (maxLoadFactor <= 0.0 || maxLoadFactor >= 1.0) || (minLoadFactor >= maxLoadFactor)</tt> * . */ protected void setUp(int initialCapacity, double minLoadFactor, diff --git a/nuiton-matrix/src/main/java/cern/colt/map/OpenIntIntHashMap.java b/nuiton-matrix/src/main/java/cern/colt/map/OpenIntIntHashMap.java index dd4bed3..075b941 100644 --- a/nuiton-matrix/src/main/java/cern/colt/map/OpenIntIntHashMap.java +++ b/nuiton-matrix/src/main/java/cern/colt/map/OpenIntIntHashMap.java @@ -97,7 +97,7 @@ public class OpenIntIntHashMap extends AbstractIntIntMap { * the maximum load factor. * @throws IllegalArgumentException * if - * <tt>initialCapacity < 0 || (minLoadFactor < 0.0 || minLoadFactor >= 1.0) || (maxLoadFactor <= 0.0 || maxLoadFactor >= 1.0) || (minLoadFactor >= maxLoadFactor)</tt> + * <tt>initialCapacity < 0 || (minLoadFactor < 0.0 || minLoadFactor >= 1.0) || (maxLoadFactor <= 0.0 || maxLoadFactor >= 1.0) || (minLoadFactor >= maxLoadFactor)</tt> * . */ public OpenIntIntHashMap(int initialCapacity, double minLoadFactor, @@ -240,9 +240,9 @@ public class OpenIntIntHashMap extends AbstractIntIntMap { * the key to be added to the receiver. * @return the index where the key would need to be inserted, if it is not * already contained. Returns -index-1 if the key is already - * contained at slot index. Therefore, if the returned index < 0, + * contained at slot index. Therefore, if the returned index < 0, * then it is already contained at slot -index-1. If the returned - * index >= 0, then it is NOT already contained and should be + * index >= 0, then it is NOT already contained and should be * inserted at slot index. */ protected int indexOfInsertion(int key) { @@ -404,7 +404,7 @@ public class OpenIntIntHashMap extends AbstractIntIntMap { * IntIntProcedure condition = new IntIntProcedure() { // match even keys only * public boolean apply(int key, int value) { return key%2==0; } * } - * keys = (8,7,6), values = (1,2,2) --> keyList = (6,8), valueList = (2,1)</tt> + * keys = (8,7,6), values = (1,2,2) --> keyList = (6,8), valueList = (2,1) * </pre> * * @param condition @@ -558,7 +558,7 @@ public class OpenIntIntHashMap extends AbstractIntIntMap { * the maxLoadFactor of the receiver. * @throws IllegalArgumentException * if - * <tt>initialCapacity < 0 || (minLoadFactor < 0.0 || minLoadFactor >= 1.0) || (maxLoadFactor <= 0.0 || maxLoadFactor >= 1.0) || (minLoadFactor >= maxLoadFactor)</tt> + * <tt>initialCapacity < 0 || (minLoadFactor < 0.0 || minLoadFactor >= 1.0) || (maxLoadFactor <= 0.0 || maxLoadFactor >= 1.0) || (minLoadFactor >= maxLoadFactor)</tt> * . */ protected void setUp(int initialCapacity, double minLoadFactor, diff --git a/nuiton-matrix/src/main/java/cern/colt/map/OpenIntObjectHashMap.java b/nuiton-matrix/src/main/java/cern/colt/map/OpenIntObjectHashMap.java index 5276def..eb5a23f 100644 --- a/nuiton-matrix/src/main/java/cern/colt/map/OpenIntObjectHashMap.java +++ b/nuiton-matrix/src/main/java/cern/colt/map/OpenIntObjectHashMap.java @@ -16,7 +16,7 @@ import cern.colt.list.IntArrayList; import cern.colt.list.ObjectArrayList; /** - * Hash map holding (key,value) associations of type <tt>(int-->Object)</tt>; Automatically grows and shrinks as needed; Implemented + * Hash map holding (key,value) associations of type <tt>(int-->Object)</tt>; Automatically grows and shrinks as needed; Implemented * using open addressing with double hashing. First see the <a href="package-summary.html">package summary</a> and javadoc <a * href="package-tree.html">tree view</a> to get the broad picture. * @@ -94,7 +94,7 @@ public class OpenIntObjectHashMap<T> extends AbstractIntObjectMap<T> { * the maximum load factor. * @throws IllegalArgumentException * if - * <tt>initialCapacity < 0 || (minLoadFactor < 0.0 || minLoadFactor >= 1.0) || (maxLoadFactor <= 0.0 || maxLoadFactor >= 1.0) || (minLoadFactor >= maxLoadFactor)</tt> + * <tt>initialCapacity < 0 || (minLoadFactor < 0.0 || minLoadFactor >= 1.0) || (maxLoadFactor <= 0.0 || maxLoadFactor >= 1.0) || (minLoadFactor >= maxLoadFactor)</tt> * . */ public OpenIntObjectHashMap(int initialCapacity, double minLoadFactor, double maxLoadFactor) { @@ -218,8 +218,8 @@ public class OpenIntObjectHashMap<T> extends AbstractIntObjectMap<T> { * @param key * the key to be added to the receiver. * @return the index where the key would need to be inserted, if it is not already contained. Returns -index-1 if the key is - * already contained at slot index. Therefore, if the returned index < 0, then it is already contained at slot -index-1. If - * the returned index >= 0, then it is NOT already contained and should be inserted at slot index. + * already contained at slot index. Therefore, if the returned index < 0, then it is already contained at slot -index-1. If + * the returned index >= 0, then it is NOT already contained and should be inserted at slot index. */ protected int indexOfInsertion(int key) { final int tab[] = table; @@ -370,7 +370,7 @@ public class OpenIntObjectHashMap<T> extends AbstractIntObjectMap<T> { * IntObjectProcedure condition = new IntObjectProcedure() { // match even keys only * public boolean apply(int key, Object value) { return key%2==0; } * } - * keys = (8,7,6), values = (1,2,2) --> keyList = (6,8), valueList = (2,1)</tt> + * keys = (8,7,6), values = (1,2,2) --> keyList = (6,8), valueList = (2,1) * </pre> * * @param condition @@ -501,7 +501,7 @@ public class OpenIntObjectHashMap<T> extends AbstractIntObjectMap<T> { * the maxLoadFactor of the receiver. * @throws IllegalArgumentException * if - * <tt>initialCapacity < 0 || (minLoadFactor < 0.0 || minLoadFactor >= 1.0) || (maxLoadFactor <= 0.0 || maxLoadFactor >= 1.0) || (minLoadFactor >= maxLoadFactor)</tt> + * <tt>initialCapacity < 0 || (minLoadFactor < 0.0 || minLoadFactor >= 1.0) || (maxLoadFactor <= 0.0 || maxLoadFactor >= 1.0) || (minLoadFactor >= maxLoadFactor)</tt> * . */ protected void setUp(int initialCapacity, double minLoadFactor, double maxLoadFactor) { diff --git a/nuiton-matrix/src/main/java/cern/colt/map/OpenLongObjectHashMap.java b/nuiton-matrix/src/main/java/cern/colt/map/OpenLongObjectHashMap.java index 8cf8820..330ef2e 100644 --- a/nuiton-matrix/src/main/java/cern/colt/map/OpenLongObjectHashMap.java +++ b/nuiton-matrix/src/main/java/cern/colt/map/OpenLongObjectHashMap.java @@ -16,7 +16,7 @@ import cern.colt.list.LongArrayList; import cern.colt.list.ObjectArrayList; /** - * Hash map holding (key,value) associations of type <tt>(long-->Object)</tt>; + * Hash map holding (key,value) associations of type <tt>(long-->Object)</tt>; * Automatically grows and shrinks as needed; Implemented using open addressing * with double hashing. First see the <a href="package-summary.html">package * summary</a> and javadoc <a href="package-tree.html">tree view</a> to get the @@ -98,7 +98,7 @@ public class OpenLongObjectHashMap<T> extends AbstractLongObjectMap<T> { * the maximum load factor. * @throws IllegalArgumentException * if - * <tt>initialCapacity < 0 || (minLoadFactor < 0.0 || minLoadFactor >= 1.0) || (maxLoadFactor <= 0.0 || maxLoadFactor >= 1.0) || (minLoadFactor >= maxLoadFactor)</tt> + * <tt>initialCapacity < 0 || (minLoadFactor < 0.0 || minLoadFactor >= 1.0) || (maxLoadFactor <= 0.0 || maxLoadFactor >= 1.0) || (minLoadFactor >= maxLoadFactor)</tt> * . */ public OpenLongObjectHashMap(int initialCapacity, double minLoadFactor, @@ -240,9 +240,9 @@ public class OpenLongObjectHashMap<T> extends AbstractLongObjectMap<T> { * the key to be added to the receiver. * @return the index where the key would need to be inserted, if it is not * already contained. Returns -index-1 if the key is already - * contained at slot index. Therefore, if the returned index < 0, + * contained at slot index. Therefore, if the returned index < 0, * then it is already contained at slot -index-1. If the returned - * index >= 0, then it is NOT already contained and should be + * index >= 0, then it is NOT already contained and should be * inserted at slot index. */ protected int indexOfInsertion(long key) { @@ -403,7 +403,7 @@ public class OpenLongObjectHashMap<T> extends AbstractLongObjectMap<T> { * LongObjectProcedure condition = new LongObjectProcedure() { // match even keys only * public boolean apply(long key, Object value) { return key%2==0; } * } - * keys = (8,7,6), values = (1,2,2) --> keyList = (6,8), valueList = (2,1)</tt> + * keys = (8,7,6), values = (1,2,2) --> keyList = (6,8), valueList = (2,1) * </pre> * * @param condition @@ -546,7 +546,7 @@ public class OpenLongObjectHashMap<T> extends AbstractLongObjectMap<T> { * the maxLoadFactor of the receiver. * @throws IllegalArgumentException * if - * <tt>initialCapacity < 0 || (minLoadFactor < 0.0 || minLoadFactor >= 1.0) || (maxLoadFactor <= 0.0 || maxLoadFactor >= 1.0) || (minLoadFactor >= maxLoadFactor)</tt> + * <tt>initialCapacity < 0 || (minLoadFactor < 0.0 || minLoadFactor >= 1.0) || (maxLoadFactor <= 0.0 || maxLoadFactor >= 1.0) || (minLoadFactor >= maxLoadFactor)</tt> * . */ protected void setUp(int initialCapacity, double minLoadFactor, diff --git a/nuiton-matrix/src/main/java/cern/colt/map/QuickOpenIntIntHashMap.java b/nuiton-matrix/src/main/java/cern/colt/map/QuickOpenIntIntHashMap.java index ad3d6f8..e89f794 100644 --- a/nuiton-matrix/src/main/java/cern/colt/map/QuickOpenIntIntHashMap.java +++ b/nuiton-matrix/src/main/java/cern/colt/map/QuickOpenIntIntHashMap.java @@ -4,14 +4,14 @@ Permission to use, copy, modify, distribute and sell this software and its docum is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation. CERN makes no representations about the suitability of this software for any purpose. -It is provided "as is" without expressed or implied warranty. +It is provided "as is" without expressed or implied warranty. %%Ignore-License */ package cern.colt.map; /** * Status: Experimental; Do not use for production yet. Hash map holding - * (key,value) associations of type <tt>(int-->int)</tt>; Automatically grows + * (key,value) associations of type <tt>(int-->int)</tt>; Automatically grows * and shrinks as needed; Implemented using open addressing with double hashing. * First see the <a href="package-summary.html">package summary</a> and javadoc * <a href="package-tree.html">tree view</a> to get the broad picture. @@ -65,7 +65,7 @@ public class QuickOpenIntIntHashMap extends OpenIntIntHashMap { * the maximum load factor. * @throws IllegalArgumentException * if - * <tt>initialCapacity < 0 || (minLoadFactor < 0.0 || minLoadFactor >= 1.0) || (maxLoadFactor <= 0.0 || maxLoadFactor >= 1.0) || (minLoadFactor >= maxLoadFactor)</tt> + * <tt>initialCapacity < 0 || (minLoadFactor < 0.0 || minLoadFactor >= 1.0) || (maxLoadFactor <= 0.0 || maxLoadFactor >= 1.0) || (minLoadFactor >= maxLoadFactor)</tt> * . */ public QuickOpenIntIntHashMap(int initialCapacity, double minLoadFactor, diff --git a/nuiton-matrix/src/main/java/org/nuiton/math/matrix/AbstractMatrixND.java b/nuiton-matrix/src/main/java/org/nuiton/math/matrix/AbstractMatrixND.java index 0f5d095..c3927bf 100644 --- a/nuiton-matrix/src/main/java/org/nuiton/math/matrix/AbstractMatrixND.java +++ b/nuiton-matrix/src/main/java/org/nuiton/math/matrix/AbstractMatrixND.java @@ -205,7 +205,7 @@ public abstract class AbstractMatrixND implements MatrixND { // AbstractMatrixND /** * {@inheritDoc} * - * @deprecated Use #setSemantic(dim, List<E>) + * @deprecated Use #setSemantic(dim, List) */ @Deprecated @Override -- To stop receiving notification emails like this one, please contact nuiton.org SCM administrator <admin+scm@nuiton.org>.