de.qaware.chronix.dtw.WarpPath.java Source code

Introduction

Here is the source code for de.qaware.chronix.dtw.WarpPath.java

Source

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2016 Stan Salvador (stansalvador@hotmail.com), Philip Chan (pkc@cs.fit.edu), QAware GmbH
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package de.qaware.chronix.dtw;

import de.qaware.chronix.dt.IntList;
import de.qaware.chronix.matrix.ColMajorCell;
import org.apache.commons.lang3.builder.EqualsBuilder;
import org.apache.commons.lang3.builder.HashCodeBuilder;

import java.util.NoSuchElementException;

/**
 * @author Stan Salvador (stansalvador@hotmail.com)
 * @author f.lautenschlager
 */
public final class WarpPath {
    private final IntList tsIindexes;
    private final IntList tsJindexes;

    public WarpPath(int initialCapacity) {
        tsIindexes = new IntList(initialCapacity);
        tsJindexes = new IntList(initialCapacity);
    }

    /**
     * @return the size of the warp path
     */
    public int size() {
        return tsIindexes.size();
    }

    /**
     * @return the min i index (last element), -1 if empty
     */
    public int minI() {
        if (tsIindexes.size() > 0) {
            return tsIindexes.get(tsIindexes.size() - 1);
        }
        return -1;
    }

    /**
     * @return the min j index
     */
    public int minJ() {
        if (tsJindexes.size() > 0) {
            return tsJindexes.get(tsJindexes.size() - 1);
        }
        return -1;
    }

    /**
     * @return max i index (first element), -1 if empty
     */
    public int maxI() {
        if (tsIindexes.size() > 0) {
            return tsIindexes.get(0);
        }
        return -1;
    }

    /**
     * @return max j index (first element), -1 if empty
     */
    public int maxJ() {
        if (tsJindexes.size() > 0) {
            return tsJindexes.get(0);
        }
        return -1;
    }

    public void add(int i, int j) {
        tsIindexes.add(i);
        tsJindexes.add(j);
    }

    public ColMajorCell get(int index) {
        if ((index > this.size()) || (index < 0))
            throw new NoSuchElementException();
        else
            return new ColMajorCell(tsIindexes.get(tsIindexes.size() - index - 1),
                    tsJindexes.get(tsJindexes.size() - index - 1));
    }

    @Override
    public String toString() {
        StringBuilder outStr = new StringBuilder("[");
        for (int x = 0; x < tsIindexes.size(); x++) {
            outStr.append("(").append(tsIindexes.get(x)).append(",").append(tsJindexes.get(x)).append(")");
            if (x < tsIindexes.size() - 1)
                outStr.append(",");
        }
        outStr.append("]");

        return outStr.toString();
    }

    @Override
    public boolean equals(Object obj) {
        if ((obj instanceof WarpPath)) // trivial false test
        {
            final WarpPath p = (WarpPath) obj;
            if ((p.size() == this.size()) && (p.maxI() == this.maxI()) && (p.maxJ() == this.maxJ())) // less trivial reject
            {
                // Compare each value in the warp path for equality
                for (int x = 0; x < this.size(); x++)
                    if (!(this.get(x).equals(p.get(x))))
                        return false;

                return true;
            } else
                return false;
        } else
            return false;
    }

    @Override
    public int hashCode() {
        return new HashCodeBuilder().append(tsIindexes).append(tsJindexes).toHashCode();
    }
}