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.math.geometry.transforms;
031
032import java.util.List;
033
034import org.openimaj.math.model.EstimatableModel;
035import org.openimaj.util.pair.IndependentPair;
036
037/**
038 * A {@link NullModel} models a one-to-one mapping of data. For convenience the
039 * {@link EstimatableModel} interface is implemented, although estimating does
040 * absolutely nothing!
041 * 
042 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
043 * @param <T>
044 *            The type of data
045 * 
046 */
047public class NullModel<T> implements EstimatableModel<T, T> {
048
049        @Override
050        public T predict(T data) {
051                return data;
052        }
053
054        @SuppressWarnings("unchecked")
055        @Override
056        public NullModel<T> clone() {
057                try {
058                        return (NullModel<T>) super.clone();
059                } catch (final CloneNotSupportedException e) {
060                        throw new RuntimeException(e);
061                }
062        }
063
064        @Override
065        public boolean estimate(List<? extends IndependentPair<T, T>> data) {
066                // do nothing
067                return true;
068        }
069
070        @Override
071        public int numItemsToEstimate() {
072                return 0;
073        }
074}