boofcv.struct.feature.TupleDesc Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of boofcv-feature Show documentation

BoofCV is an open source Java library for real-time computer vision and robotics applications.

There is a newer version: 1.1.7

/*
 * Copyright (c) 2011-2017, 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.feature;

import java.io.Serializable;

/**
 * Base class for tuple based feature descriptors
 *
 * @author Peter Abeles
 */
public interface TupleDesc extends Serializable {

	/**
	 * Sets this tuple to be the same as the provided tuple
	 * @param source The tuple which this one is to become a copy of.
	 */
	void setTo( T source );

	/**
	 * Returns the value of a tuple's element as a double.  In general this function should not be used
	 * because of how inefficient it is.
	 *
	 * @param index Which element
	 * @return Element's value as a double
	 */
	double getDouble( int index );

	/**
	 * Number of elements in the tuple.
	 *
	 * @return Number of elements in the tuple
	 */
	int size();

	/**
	 * Creates a copy of this description
	 *
	 * @return Copy
	 */
	T copy();
}