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.timeseries.processor.interpolation.util;
031
032import org.openimaj.ml.timeseries.TimeSeries;
033
034/**
035 * Some utility functions used by various {@link TimeSeries} classes to get arrays of spans of time
036 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
037 *
038 */
039public class TimeSpanUtils {
040        /**
041         * Get
042         * @param begin
043         * @param end
044         * @param delta
045         * @return longs evenly spaced between from begin and less than end with spacings of delta
046         */
047        public static long[] getTime(long begin, long end, long delta) {
048                long[] times = new long[(int) ((end - begin)/delta) + 1];
049                long val = begin;
050                for (int i = 0; i < times.length; i++) {
051                        times[i] = val;
052                        val += delta;
053                }
054                return times;
055        }
056        
057        /**
058         * @param begin
059         * @param end
060         * @param splits
061         * @return longs starting from begin and less than end such that "splits" times are returned and delta between the times is (end-begin)/(splits-1)
062         */
063        public static long[] getTime(long begin, long end, int splits) {
064                long[] times = new long[splits];
065                long delta = (end - begin) / (splits-1);
066                long val = begin;
067                for (int i = 0; i < times.length; i++) {
068                        times[i] = val;
069                        val += delta;
070                }
071                return times;
072        }
073        
074        /**
075         * @param begin
076         * @param steps
077         * @param delta
078         * @return "steps" longs starting from begin spaced by delta 
079         */
080        public static long[] getTime(long begin, int steps, long delta){
081                long[] times = new long[steps];
082                long val = begin;
083                for (int i = 0; i < times.length; i++) {
084                        times[i] = val;
085                        val += delta;
086                }
087                return times;
088        }
089}