1 // ******************************************************************************
2 //
3 // Title: Force Field X.
4 // Description: Force Field X - Software for Molecular Biophysics.
5 // Copyright: Copyright (c) Michael J. Schnieders 2001-2025.
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.numerics.clustering.visualization;
39
40 /**
41 * Immutable Virtual coordinate.
42 *
43 * @author Lars Behnke, 2013
44 * @author Michael J. Schnieders
45 * @since 1.0
46 */
47 public record VCoord(double x, double y) {
48
49 /**
50 * Constructs an immutable virtual coordinate with the given X and Y values.
51 *
52 * @param x the X value in model space
53 * @param y the Y value in model space
54 */
55 public VCoord {
56 }
57
58 /**
59 * Returns the X coordinate value in model space.
60 *
61 * @return the X value
62 */
63 @Override
64 public double x() {
65 return x;
66 }
67
68 /**
69 * Returns the Y coordinate value in model space.
70 *
71 * @return the Y value
72 */
73 @Override
74 public double y() {
75 return y;
76 }
77
78 /**
79 * Compares this coordinate to another object for equality. Two VCoord instances are
80 * considered equal if both their X and Y values are exactly equal.
81 *
82 * @param obj the object to compare against
83 * @return true if obj is a VCoord with identical X and Y; false otherwise
84 */
85 @Override
86 public boolean equals(Object obj) {
87 if (obj instanceof VCoord(double x1, double y1)) {
88 return x == x1 && y == y1;
89 } else {
90 return false;
91 }
92 }
93
94 /**
95 * Returns a string representation of this coordinate in the form "Coord(x,y)"
96 * with values formatted to three decimal places.
97 *
98 * @return a human-readable string of this coordinate
99 */
100 @Override
101 public String toString() {
102 return String.format("Coord(%.3f,%.3f)", x, y);
103 }
104
105 }