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.data;
031
032/**
033 * A source which returns data of type DATATYPE. Classes which implement this interface must support
034 * random access to rows as well as the ability to get random subsets of data.
035 * 
036 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
037 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
038 *
039 * @param <DATATYPE> the data type which can be returned
040 */
041public interface DataSource<DATATYPE> extends Iterable<DATATYPE> {
042        /**
043         * Get data between given rows. startRow must be > 0, stopRow must be smaller than {@link DataSource#numRows()}. 
044         * 
045         *  data is guaranteed to have (stopRow - startRow) valid entries 
046         * 
047         * @param startRow where to start (inclusive)
048         * @param stopRow where to stop (exclusive)
049         * @param data the array to fill
050         */
051        public void getData(int startRow, int stopRow, DATATYPE[] data);
052
053        /**
054         * Get the data for a given row
055         * @param row the row number
056         * @return the data for the row
057         */
058        public DATATYPE getData(int row);
059        
060        /**
061         * @return Number of dimensions of each data point
062         */
063        public int numDimensions();
064
065        /**
066         * @param data a random set of data. This array is guaranteed to be filled.
067         */
068        public void getRandomRows(DATATYPE[] data);
069
070        /**
071         * @return the number of data points
072         */
073        public int numRows();
074}