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