boofcv.struct.ScoreIndex Maven / Gradle / Ivy

/*
 * Copyright (c) 2011-2019, Peter Abeles. All Rights Reserved.
 *
 * This file is part of BoofCV (http://boofcv.org).
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package boofcv.struct;

/**
 * Data structure consisting of a score and index. Designed so that you can easily sort
 *
 * @author Peter Abeles
 */
public class ScoreIndex implements Comparable
{
	public double score;
	public int index;

	public ScoreIndex(double score, int index) {
		this.score = score;
		this.index = index;
	}

	public ScoreIndex() {
	}

	public ScoreIndex set(double score, int index) {
		this.score = score;
		this.index = index;
		return this;
	}

	@Override
	public int compareTo(ScoreIndex o) {
		if( score < o.score )
			return -1;
		else if( score > o.score )
			return 1;
		else
			return 0;
	}

	@Override
	public int hashCode() {
		return index;
	}
}