1 /**
2 * Copyright (c) 2011, The University of Southampton and the individual contributors.
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without modification,
6 * are permitted provided that the following conditions are met:
7 *
8 * * Redistributions of source code must retain the above copyright notice,
9 * this list of conditions and the following disclaimer.
10 *
11 * * Redistributions in binary form must reproduce the above copyright notice,
12 * this list of conditions and the following disclaimer in the documentation
13 * and/or other materials provided with the distribution.
14 *
15 * * Neither the name of the University of Southampton nor the names of its
16 * contributors may be used to endorse or promote products derived from this
17 * software without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
26 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30 package org.openimaj.ml.classification;
31
32 public interface LabelledDataProvider {
33
34 /**
35 * Get the response for all items for a specific dimension of each feature
36 * vector
37 *
38 * @param dimension
39 * the dimension to select
40 * @return a vector of responses
41 */
42 float[] getFeatureResponse(int dimension);
43
44 /**
45 * Get the feature vector for a specific instance
46 *
47 * @param idx
48 * the index of the instance
49 * @return the feature vector
50 */
51 float[] getInstanceFeature(int idx);
52
53 /**
54 * @return get the classes.
55 */
56 boolean[] getClasses();
57
58 int numInstances();
59
60 int numDimensions();
61
62 /**
63 * Get the indices of the responses corresponding to a specific dimension
64 * for all items ordered such that the responses are ascending.
65 *
66 * @param d
67 * the dimension to select
68 * @return the indices ordered by the corresponding ascending response
69 * values
70 */
71 int[] getSortedResponseIndices(int d);
72 }