001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package org.openimaj.ml.classification;
031
032public interface LabelledDataProvider {
033
034        /**
035         * Get the response for all items for a specific dimension of each feature
036         * vector
037         *
038         * @param dimension
039         *            the dimension to select
040         * @return a vector of responses
041         */
042        float[] getFeatureResponse(int dimension);
043
044        /**
045         * Get the feature vector for a specific instance
046         *
047         * @param idx
048         *            the index of the instance
049         * @return the feature vector
050         */
051        float[] getInstanceFeature(int idx);
052
053        /**
054         * @return get the classes.
055         */
056        boolean[] getClasses();
057
058        int numInstances();
059
060        int numDimensions();
061
062        /**
063         * Get the indices of the responses corresponding to a specific dimension
064         * for all items ordered such that the responses are ascending.
065         *
066         * @param d
067         *            the dimension to select
068         * @return the indices ordered by the corresponding ascending response
069         *         values
070         */
071        int[] getSortedResponseIndices(int d);
072}