org.openimaj.ml.classification.LabelledDataProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sandbox Show documentation

A project for various tests that don't quite constitute demos but might be useful to look at.

There is a newer version: 1.3.10

/**
 * Copyright (c) 2011, The University of Southampton and the individual contributors.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 *   * 	Redistributions of source code must retain the above copyright notice,
 * 	this list of conditions and the following disclaimer.
 *
 *   *	Redistributions in binary form must reproduce the above copyright notice,
 * 	this list of conditions and the following disclaimer in the documentation
 * 	and/or other materials provided with the distribution.
 *
 *   *	Neither the name of the University of Southampton nor the names of its
 * 	contributors may be used to endorse or promote products derived from this
 * 	software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.openimaj.ml.classification;

public interface LabelledDataProvider {

	/**
	 * Get the response for all items for a specific dimension of each feature
	 * vector
	 *
	 * @param dimension
	 *            the dimension to select
	 * @return a vector of responses
	 */
	float[] getFeatureResponse(int dimension);

	/**
	 * Get the feature vector for a specific instance
	 *
	 * @param idx
	 *            the index of the instance
	 * @return the feature vector
	 */
	float[] getInstanceFeature(int idx);

	/**
	 * @return get the classes.
	 */
	boolean[] getClasses();

	int numInstances();

	int numDimensions();

	/**
	 * Get the indices of the responses corresponding to a specific dimension
	 * for all items ordered such that the responses are ascending.
	 *
	 * @param d
	 *            the dimension to select
	 * @return the indices ordered by the corresponding ascending response
	 *         values
	 */
	int[] getSortedResponseIndices(int d);
}