View Javadoc

1   /*
2    * Cell.java
3    *
4    * Created on April 4, 2006, 11:09 AM
5    *
6    * $Id: $
7    */
8   package org.lcsim.recon.cluster.localequivalence;
9   
10  /**
11   * A cell with properties adapted to a nearest-neighbor clustering algorithm
12   * whose metric for "nearest" is based on value().
13   *
14   * @author Norman Graf
15   */
16  public abstract class Cell implements Comparable
17  {
18      /**
19       *
20       * @return A value for weighting multiple neighbors.
21       */
22      public abstract double value();
23  
24      /**
25       *
26       * @return A unique identifier associated with this cell
27       */
28      public abstract long cellID();
29  
30      /**
31       *
32       * @return A Cell to which this Cell points.
33       */
34      public abstract Cell pointsTo();
35  
36      /**
37       *
38       * @param pointsto Assign a Cell to which this Cell points.
39       */
40      public abstract void pointsTo(Cell pointsto);
41  
42      /**
43       *
44       * @param cell Assign a Cell which points to this Cell.
45       */
46      public abstract void pointedTo(Cell cell);
47  
48      /**
49       *
50       * @return A Cell which points to this Cell.
51       */
52      public abstract Cell pointedTo();
53  
54  }