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.feature;
031
032/**
033 * Abstract base class for all types of {@link FeatureVector} that are backed by
034 * a native array.
035 * 
036 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
037 * 
038 * @param <ARRAYTYPE>
039 *            Primitive a type of the backing array
040 */
041public abstract class ArrayFeatureVector<ARRAYTYPE> implements FeatureVector {
042        private static final long serialVersionUID = 1L;
043
044        /**
045         * Array of all the values in the feature vector
046         */
047        public ARRAYTYPE values;
048
049        /**
050         * Get the underlying representation
051         * 
052         * @return the feature as an array
053         */
054        @Override
055        public ARRAYTYPE getVector() {
056                return values;
057        }
058
059        /**
060         * Returns a new featurevector that is a subsequence of this vector. The
061         * subsequence begins with the element at the specified index and extends to
062         * the end of this vector.
063         * 
064         * @param beginIndex
065         *            the beginning index, inclusive.
066         * @return the specified subvector.
067         * @exception IndexOutOfBoundsException
068         *                if <code>beginIndex</code> is negative or larger than the
069         *                length of this <code>ArrayFeatureVector</code> object.
070         */
071        public abstract ArrayFeatureVector<ARRAYTYPE> subvector(int beginIndex);
072
073        /**
074         * Returns a new string that is a subvector of this vector. The subvector
075         * begins at the specified <code>beginIndex</code> and extends to the
076         * element at index <code>endIndex - 1</code>. Thus the length of the
077         * subvector is <code>endIndex-beginIndex</code>.
078         * 
079         * @param beginIndex
080         *            the beginning index, inclusive.
081         * @param endIndex
082         *            the ending index, exclusive.
083         * @return the specified subvector.
084         * @exception IndexOutOfBoundsException
085         *                if the <code>beginIndex</code> is negative, or
086         *                <code>endIndex</code> is larger than the length of this
087         *                <code>ArrayFeatureVector</code> object, or
088         *                <code>beginIndex</code> is larger than
089         *                <code>endIndex</code>.
090         */
091        public abstract ArrayFeatureVector<ARRAYTYPE> subvector(int beginIndex, int endIndex);
092}