View Javadoc

1   package baseCode.dataFilter;
2   
3   import baseCode.dataStructure.matrix.NamedMatrix;
4   
5   /***
6    * An interface representing the functionality of a class that can filter 2-d matrix-based data by row-oriented
7    * criteria.
8    * <p>
9    * Copyright (c) 2004 Columbia University
10   * 
11   * @author Pavlidis
12   * @version $Id: Filter.java,v 1.8 2004/07/27 03:18:58 pavlidis Exp $
13   */
14  public interface Filter {
15  
16     /***
17      * Filter the data
18      * 
19      * @param data a NamedMatrix. Some types of filters require that this be of a particular type of implementation of
20      *        the Filter interface.
21      * @return The resulting filtered matrix
22      */
23     public NamedMatrix filter( NamedMatrix data );
24  }