edu.emory.mathcs.nlp.learning.gridsearch.GridFunction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nlp4j-api Show documentation

The newest version!

/**
 * Copyright 2015, Emory University
 * 
 * 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 edu.emory.mathcs.nlp.learning.gridsearch;

/**
 * @author Amit_Deshmane
 *
 * Supposed to contain an one dimensional grid.
 */
public interface GridFunction {

	/**
	 * get current value in grid
	 * @return
	 */
	public abstract float getVal();

	/**
	 * reset to initial value
	 */
	public abstract void reset();

	/**
	 * go to previous point in grid
	 * @return
	 * true if previous exists

	 * otherwise false
	 */
	public abstract boolean previous();

	/**
	 * go to next point in grid
	 * @return
	 * true if next exists

	 * otherwise false
	 */
	public abstract boolean next();

	/**
	 * set to previously marked position
	 */
	public abstract void resetToMark();

	/**
	 * mark a position for future reference
	 */
	public abstract void mark();

}