Gene.java

/*
 * Encog(tm) Core v2.5 - Java Version
 * http://www.heatonresearch.com/encog/
 * http://code.google.com/p/encog-java/
 
 * Copyright 2008-2010 Heaton Research, Inc.
 *
 * 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.
 *   
 * For more information on Heaton Research copyrights, licenses 
 * and trademarks visit:
 * http://www.heatonresearch.com/copyright
 */

package org.encog.solve.genetic.genes;

/**
 * Describes a gene. A gene is the smallest piece of genetic information in
 * Encog.
 */
public interface Gene extends Comparable<Gene> {

	/**
	 * Copy another gene to this one.
	 * 
	 * @param gene
	 *            The other gene to copy.
	 */
	void copy(Gene gene);

	/**
	 * Get the ID of this gene, -1 for undefined.
	 * 
	 * @return The ID of this gene.
	 */
	long getId();

	/**
	 * @return The innovation ID of this gene.
	 */
	long getInnovationId();

	/**
	 * @return True, if this gene is enabled.
	 */
	boolean isEnabled();

	/**
	 * Determine if this gene is enabled.
	 * 
	 * @param e
	 *            True if this gene is enabled.
	 */
	void setEnabled(boolean e);
}