1 // ******************************************************************************
2 //
3 // Title: Force Field X.
4 // Description: Force Field X - Software for Molecular Biophysics.
5 // Copyright: Copyright (c) Michael J. Schnieders 2001-2024.
6 //
7 // This file is part of Force Field X.
8 //
9 // Force Field X is free software; you can redistribute it and/or modify it
10 // under the terms of the GNU General Public License version 3 as published by
11 // the Free Software Foundation.
12 //
13 // Force Field X is distributed in the hope that it will be useful, but WITHOUT
14 // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15 // FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
16 // details.
17 //
18 // You should have received a copy of the GNU General Public License along with
19 // Force Field X; if not, write to the Free Software Foundation, Inc., 59 Temple
20 // Place, Suite 330, Boston, MA 02111-1307 USA
21 //
22 // Linking this library statically or dynamically with other modules is making a
23 // combined work based on this library. Thus, the terms and conditions of the
24 // GNU General Public License cover the whole combination.
25 //
26 // As a special exception, the copyright holders of this library give you
27 // permission to link this library with independent modules to produce an
28 // executable, regardless of the license terms of these independent modules, and
29 // to copy and distribute the resulting executable under terms of your choice,
30 // provided that you also meet, for each linked independent module, the terms
31 // and conditions of the license of that module. An independent module is a
32 // module which is not derived from or based on this library. If you modify this
33 // library, you may extend this exception to your version of the library, but
34 // you are not obligated to do so. If you do not wish to do so, delete this
35 // exception statement from your version.
36 //
37 // ******************************************************************************
38 package ffx.utilities;
39
40 import static java.lang.String.format;
41
42 /**
43 * DoubleIndexPair record.
44 * <p>
45 * Allows sorting of floating-point values while retaining knowledge of where that value was in some
46 * original list or array.
47 *
48 * @param index the original index of this double.
49 * @param doubleValue the double value.
50 * @author Jacob M. Litman
51 * @since 1.0
52 */
53 public record DoubleIndexPair(int index, double doubleValue) implements Comparable<DoubleIndexPair> {
54
55 /** {@inheritDoc} */
56 @Override
57 public int compareTo(DoubleIndexPair o) {
58 if (o == null) {
59 return 0;
60 }
61 return Double.compare(doubleValue, o.doubleValue);
62 }
63
64 /**
65 * Returns a string containing the index and double value.
66 *
67 * @return a {@link String} object
68 */
69 @Override
70 public String toString() {
71 return format(" %6d %16.8f", index, doubleValue);
72 }
73
74 }