1 /*
2 * The baseCode project
3 *
4 * Copyright (c) 2008-2019 University of British Columbia
5 *
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *
18 */
19 package ubic.basecode.datafilter;
20
21 import ubic.basecode.dataStructure.matrix.Matrix2D;
22
23 /**
24 * An interface representing the functionality of a class that can filter 2-d matrix-based data by row-oriented
25 * criteria.
26 *
27 * @author Pavlidis
28 *
29 */
30 public interface Filter<M extends Matrix2D<R, C, V>, R, C, V> {
31
32 /**
33 * Filter the data
34 *
35 * @param data a NamedMatrix. Some types of filters require that this be of a particular type of implementation of
36 * the Filter interface.
37 * @return The resulting filtered matrix
38 */
39 public M filter( M data );
40 }